• Post Reply Bookmark Topic Watch Topic
  • New Topic

Hide Comments in Javadoc  RSS feed

 
Kamal Ahmed
Ranch Hand
Posts: 91
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi,

Is there a way to HIDE Comments in JavaDoc ? I am using Eclipse as IDE.
I DID Find:

@internal

For holding comments that are internal to the company developing the code. This might contain comments about implementation details which might not be relevant to end users who are going to be using the class files. This would enable companies to have an internal version of the generated documentation that would contain more information to help other developers who may be new to the project. This information could be filtered out with a switch on the Javadoc command line when generating the documentation to distribute to clients. Syntax: @internal text


BUT this is a PROPOSED TAG.

Any help is appreciated.

Thanks,
-Kamal.
 
Ernest Friedman-Hill
author and iconoclast
Sheriff
Posts: 24217
38
Chrome Eclipse IDE Mac OS X
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Javadoc will just ignore tags it doesn't know about, so you could use this tag (or one of your own devising) to include comments that will only be seen in the source code. You could, in theory, then write your own "doclet" (Javadoc's extensibility modules, or "plugins") to create private HTML documentation for your term, or just let them read the comments in the source.
 
  • Post Reply Bookmark Topic Watch Topic
  • New Topic
Boost this thread!