javadoc

How to read Javadoc comments by reflection?

by

Doclet class: public class ExtractCommentsDoclet { public static boolean start(RootDoc root) throws IOException { for (ClassDoc c : root.classes()) { print(c.qualifiedName(), c.commentText()); for (FieldDoc f : c.fields(false)) { print(f.qualifiedName(), f.commentText()); } for (MethodDoc m : c.methods(false)) { print(m.qualifiedName(), m.commentText()); if (m.commentText() != null && m.commentText().length() > 0) { for (ParamTag p : m.paramTags()) print(m.qualifiedName() + … Read more

What’s the correct way to include an email within Javadoc?

by

The {@link} is Javadoc-specific markup. Javadocs, though, are HTML – so you can simply use /** * Embed HTML directly into the Javadoc. * * @author <a href=”https://stackoverflow.com/questions/1509817/mailto:[email protected]”>Benoit St-Pierre</a> */ public class Useless { } Whether that’s a good idea or not is a different matter. 🙂

State of the Art for Clojure Documentation Tools [closed]

by

I really like Marginalia if you want to take something like a literate programming approach. Marginalia traverses your source code, and produces an html formatted version with comments set beside code in a very clear text. Comments can be markdown formatted, making for a very readable final document. When reviewing source code that I’ve written … Read more

How to document Java Record parameters?

by

IntelliJ Bug / Missing Feature Using the in-built JDK tool for javadoc with the version 14-ea and above, I could easily generate Javadoc for a record. The command used for the same is \ /jdk-14.jdk/…/javadoc –release=14 –enable-preview …/src/main/java/…/CityRecord.java So this would certainly be something missing in IntelliJ. (Since the ‘Add Javadoc’ option also doesn’t include … Read more

How to disable Javadoc warnings in Maven Javadoc Plugin?

by

Since version 3.0.0 of the maven-javadoc-plugin you can use the doclint configuration parameter. If you just want to disable the “missing” warnings, use all,-missing: <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <version>3.0.1</version> <configuration> <doclint>all,-missing</doclint> </configuration> </plugin> For more information see the doclint parameter documentation.

How to get a JavaDoc of a method at run time?

by

The only way to get it at runtime is to use custom annotations. Create a custom annotation class: @Retention(RUNTIME) @Target(value = METHOD) public @interface ServiceDef { /** * This provides description when generating docs. */ public String desc() default “”; /** * This provides params when generating docs. */ public String[] params(); } Use it … Read more

Code example with annotation in JavaDoc

by

A more general solution: {@literal @} The {@literal} tag denotes literal text. The enclosed text is interpreted as not containing HTML markup or nested javadoc tags. For example, the doc comment text: {@literal a<B>c} displays in the generated HTML page unchanged: a<B>c — that is, the <B> is not interpreted as bold. Requires Java 5+