{
  "version": "https://jsonfeed.org/version/1.1",
  "title": "chem-bla-ics",
  "description": "Chemblaics (pronounced chem-bla-ics) is the science that uses open science and computers to solve problems in chemistry, biochemistry and related fields.",
  "home_page_url": "https://chem-bla-ics.linkedchemistry.info/",
  "feed_url": "https://chem-bla-ics.linkedchemistry.info/2009/11/07/call-for-collaboration-javadoc.json",
  "icon": "https://chem-bla-ics.linkedchemistry.info/assets/images/chem-bla-ics_logo.png",
  "language": "en",
  "authors": [
    {
      "name": "Egon Willighagen",
      "url": "https://orcid.org/0000-0001-7542-0286",
      "_orcid": "0000-0001-7542-0286"
    }
  ],
  "items": [

    {
      "id": "https://doi.org/10.59350/49cn8-6n163",
      "url": "https://chem-bla-ics.linkedchemistry.info/2009/11/07/call-for-collaboration-javadoc.html",
      "title": "Call for Collaboration: JavaDoc validation with OpenJavaDocCheck",
      "content_html": "<p>I reported recently about my efforts to write an <a href=\"https://chem-bla-ics.linkedchemistry.info/2009/10/17/work-in-progress-open-doccheck.html\">Open Source DocCheck replacement <i class=\"fa-solid fa-recycle fa-xs\"></i></a>.\nI received the first patches (from <a href=\"http://blog.rguha.net/\">Rajarshi</a>), and brought it online in a <a href=\"http://cdk.sf.net/\">CDK</a> branch (see\n<a href=\"http://pele.farmbio.uu.se/nightly-ojdcheck/ojdcheckSummary.html\">this Nightly page</a>).</p>\n\n<p><img src=\"/assets/images/ojdcheck.png\" alt=\"\" /></p>\n\n<p>This list shows a mix of tests that are now implemented in OpenJavaDocCheck itself, but the third line is actually a test that is plugged in and specific for the CDK. This is an important feature, I think, and allows users of OpenJavaDocCheck to add functionality is that is not interesting to the general public, but very interesting for the JavaDoc being analyzed. Well, at least, it is to our CDK project :)</p>\n\n<p>The current list of tests is still quite small, and consists of these tests:</p>\n\n<ul>\n  <li>test if each class and method has JavaDoc</li>\n  <li>test for missing @return tags</li>\n  <li>test for missing @param tags</li>\n  <li>test for @returns instead of @return</li>\n  <li>test @param template code, such as added by IDEs like Eclipse</li>\n  <li>test @exception template code, such as added by IDEs like Eclipse</li>\n  <li>test for redundant @version tags</li>\n</ul>\n\n<p>I am now <a href=\"http://github.com/egonw/ojdcheck/issues\">seeking feedback</a> on the current code base, and potentially collaboration with writing more\nJavaDoc validation tests. There is enough to do, and I have been thinking on tests for:</p>\n\n<ul>\n  <li>spell checking JavaDoc</li>\n  <li>checking for 404s of web pages linked with <code class=\"language-plaintext highlighter-rouge\">&lt;a href&gt;</code> in the JavaDoc</li>\n  <li>well-formedness of the HTML in the webpages</li>\n</ul>\n\n<p>And about:</p>\n\n<ul>\n  <li>a PMD-like system to allow people to choose which testing they want or not</li>\n  <li>an Eclipse plugin</li>\n</ul>",
      "summary": "I reported recently about my efforts to write an Open Source DocCheck replacement . I received the first patches (from Rajarshi), and brought it online in a CDK branch (see this Nightly page).",
      "image": "https://chem-bla-ics.linkedchemistry.info/assets/images/ojdcheck.png",
      "date_published": "2009-11-07T00:00:00+00:00",
      "date_modified": "2026-05-05T00:00:00+00:00",
      "tags": ["cdk","javadoc"],
      
      
      
      
      
      
        "authors": [ { "name": "Egon Willighagen", "url": "https://orcid.org/0000-0001-7542-0286" } ]
      
    }

  ]
}