Top "Javadoc" questions

Javadoc is an extensible documentation generation system which reads specially formatted comments in Java source code and generates compiled documentation.

Should I use /* */ or /** */ for the copyright in the top of a java file?

There is a copyright comment in each java file, but I don't know which one should I use: /* */ or /** */? /* * Copyright ... */ …

java coding-style comments javadoc copyright-display
How to quote "*/" in JavaDocs

I have a need to include */ in my JavaDoc comment. The problem is that this is also the same sequence …

java comments javadoc
Maven checkstyle error : Expected @param tag for '<T>'

I have following method with generic types, but when I run maven checkstyle(maven-checkstyle-plugin, 2.121) it kept gives me Expected @param …

java maven generics javadoc checkstyle
Where are the javadocs for Lotus' Notes.jar?

I need to use Lotus Notes/Domino as a data source from a Java application. The documentation at IBM says …

java javadoc lotus-notes
Is there an @inheritDoc equivalent in Doxygen?

I know Javadoc will compile {@inheritDoc}, but what's the Doxygen way to do this?

javadoc doxygen documentation-generation
Javadoc for local variables?

Short question: Is it possible to create Javadoc for local variables? (I just want an explanation for my local variable …

java eclipse javadoc local-variables
Are there "official" Javadocs available for MySQL JDBC Connector?

Are there javadocs available for MySQL JDBC connector? If so, where can I find them? Googling around, I've come across …

documentation javadoc mysql-connector
Should I write multiple @return tags in javadoc

Say I have a java method that returns an array of strings. Inside the method, I have more than one …

java return javadoc code-documentation
How can weakCompareAndSet fail spuriously if it is implemented exactly like compareAndSet?

(note that this question is not about CAS, it's about the "May fail spuriously" Javadoc). The only difference in the …

java concurrency javadoc
Maven site (Maven 3) generates empty site folder

I'm attempting to create a basic maven site using the maven site plugin. So I added this to my pom: &…

java maven javadoc maven-javadoc-plugin maven-site-plugin