Stack Overflow
Stack Overflow

Questions tagged [javadoc]

Javadoc is an extensible documentation generation system which reads specially formatted comments in Java source code and generates compiled documentation. It is typically used to produce API documentation in the form of HTML web pages.

Javadoc is an extensible documentation generation system which reads specially formatted comments in Java source code and generates compiled documentation. It is typically used to produce API documentation in the form of HTML web pages.

A Javadoc comment starts with /** (an extra star to the normal multi-line comment) and ends with */. It also makes use of tags (starting with @).

Resources

2947 questions
29
votes
3 answers

Javadoc @link references in Android Studio

I'm trying to generate some Javadocs with Android Studio. I'm referring with {@link #method()} a method in the same class as the link but I still get a reference not found error from Javadoc. I'm probably omitting something very stupid but I cannot…
Genís
  • 1,468
  • 2
  • 13
  • 24
29
votes
7 answers

How configure Intellij Idea javadoc templates?

I have some method: public int getSomeField() I want to generate javadoc like this: /** * Gets {someField} * * @return value of {someField} */ Where {someField} is placeholder for field name. It is possible to create this templates for Intellij…
Cherry
  • 31,309
  • 66
  • 224
  • 364
29
votes
2 answers

Javadoc displaying value on an inner class constant using @value

I have an inner class which declares a constant and want to display its value in Javadoc of the enclosing top-level class using the @value annotation. For example: /** * {@value #FOO_CONS} // this displays well * {@value #BAR_CONS} // this does…
eold
  • 5,972
  • 11
  • 56
  • 75
28
votes
2 answers

Does "/* (non-javadoc)" have a well-understood meaning?

Does /* (non-javadoc) have a meaning, beyond pointing out to the reader of source code that a comment block is intentionally not a Javadoc comment? Lately I've seen a lot of code that looks like this: /* * (non-javadoc) * * This method converts…
Pops
  • 30,199
  • 37
  • 136
  • 151
28
votes
7 answers

How to generate links to the android Classes' reference in javadoc?

When I generate javadoc for my Android project in Eclipse, there are lots of warnings like cannot find symbol symbol : class TextView and warning - Tag @see: reference not found: android.app.Dialog I also tried -link…
Vasu
  • 4,862
  • 8
  • 42
  • 48
28
votes
4 answers

How to add external library's sources and javadoc to gradle with IntelliJ?

I've set up a Java project with IntelliJ and Gradle. I have a build.gradle file in my root project and I can compile and run my app. However... I'm using a Java library which comes with a sources and javadoc zip file. If I'm in my source code and…
kruze
  • 361
  • 1
  • 3
  • 8
28
votes
4 answers

Does Javadoc have an equivalent to ?

Unfortunately, there is no CDATA in HTML. This is a pity, because it would be perfect for adding javadoc comments that include XML, so you don't have to escape the < and >, for example: /** ]]>*/ However,…
13ren
  • 11,887
  • 9
  • 47
  • 64
28
votes
2 answers

Why are duplicate method suggestions appearing in Eclipse?

This problem also occurs with other methods but I am just using ArrayList.contains(Object o) as an example. The method appears twice in Eclipse's method suggestions but one of them with a percentage. As far as I can tell it seems to be a…
njallam
  • 476
  • 9
  • 23
27
votes
6 answers

How can I automatically update the Javadoc when changing the method signature in Eclipse?

I am using Eclipse IDE for my Java Project. I have one problem. I have the methods in my project which have the javadoc comments like as follows: /** * Retruns the string representation of a input stream * @param in * @return * @throws…
Amit
  • 33,847
  • 91
  • 226
  • 299
27
votes
7 answers

Generate javadoc only with JRE

I would like to be able to generate javadoc for my maven projects even when running under a JRE instead of a JDK, where the javadoc command invoked by maven is found. In other words, not relying on anything but what is in the JRE and what Maven can…
Thorbjørn Ravn Andersen
  • 73,784
  • 33
  • 194
  • 347
27
votes
1 answer

"javadoc" in C#

I have been looking online to find out how to "javadoc" in C# console application. All the articles refer to a webform of C# in the case for that, /// would be the javadoc. What is the way to do it if you are making a console application in visual…
haysam
  • 401
  • 5
  • 11
  • 16
26
votes
13 answers

Obtain and download Javadoc (JDK documentation) to a local file for offline reading

When writing Java code, I refer extensively to the Javadoc—that is, the Java® Platform, Standard Edition & Java Development Kit Version x API Specification. I know how to read it online from the website, but I would like to download a copy to my…
Luke Dowell
  • 271
  • 1
  • 3
  • 4
26
votes
2 answers

Gradle exclude R.java in Android Javadocs when internal classes depend on R.java

I am building JavaDoc for an API wherein classes in the API depend on R.java. I want to build the Javadoc w/o symbol errors referencing the missing R.java file as even when I set failOnError false the build succeeds but our Jenkins job will report…
jdONeill
  • 443
  • 6
  • 10
26
votes
1 answer

How can I enable Javadoc warnings in Eclipse?

Is it possible in Eclipse to have the warnings displayed in the editor about Javadoc issues. for example, I often rename / change parameters of methods and forget to update the Javadoc accordingly. This would be great to notice that before the next…
Raphael Jolivet
  • 3,940
  • 5
  • 36
  • 56
26
votes
13 answers

How to manage @todo programming stuff?

For many years my code was full of this kind of comments : //TODO : Add ... ... /* *TODO : Fix ... * */ Now I think to create my own @todo javadoc annotation ... but before doing that I want to know if do you guys have better way to manage your…
wj.
  • 2,001
  • 3
  • 18
  • 19
1 2 3
…
99 100