#523 JavaDoc Check: Support (non-Javadoc)

Future
closed
nobody
Check (274)
5
2014-02-07
2009-06-18
Billy Cole
No

Within Eclipse when you override or implement a method you can inherit the java doc for the method. Eclipse will produce the following:
/
* (non-Javadoc)
* @see junit.framework.TestCase#setUp()
*

/

CheckStyle will flag the method as not having JavaDoc.

Hava the JavaDoc check aware of inherited java doc by being aware that inherited java doc format as presented by Eclipse and supported using the java doc generation tool.

James Tauber detailed the possible out comes of working with Eclipse and inherited java doc or trying to adhere to the CheckStyle java doc check. With the (non-javadoc), Eclipse will actually link and present the inherited java doc when viewing the override or implementation.
http://jtauber.com/blog/2004/05/11/inheriting_doc_in_javadoc_and_eclipse/

Discussion

  • Billy Cole

    Billy Cole - 2009-06-18

    Did additional searches and while the other entries did not use (non-Javadoc) within the description there are several mentions of inherited java doc.

     
  • Ivan Sopov

    Ivan Sopov - 2014-02-07
     
  • Ivan Sopov

    Ivan Sopov - 2014-02-07
    • status: open --> closed
     

Log in to post a comment.

Get latest updates about Open Source Projects, Conferences and News.

Sign up for the SourceForge newsletter:

JavaScript is required for this form.





No, thanks