Search code examples
javaannotationsjavadoc

Annotation to disable JavaDocs

Is there an annotation to declare that a certain method will not be included in the JavaDocs even though it is public?

Something like:

@nojavadocs
public void foo(){
//...
}

P.S. I understand the point here about API, but the methods are simply "unsupported." They work (and must be public for access from other packages), but we do not want to bother documenting them and answering questions about how to use them when their functionality is not relevant to supported usage scenarios. Good design might mean moving them to another class, but they logically refer to the data in the class.

Solution

  • Not if you're using Sun's JavaDocs tool.

    They have a feature request for it, but it's been in low priority since 1997.

    You can write a custom doclet to overcome this, or use a 3rd-party tool (DocFlex or such).