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
1
vote
1 answer

Force Netbeans to generate partially-qualified javadoc

several methods I have return Map objects like (partially-qualified) Map which turn out in the NetBeans (7.0.1) generated javadoc as fully-qualified: java.util.Map Do you know whether it's…
plesatejvlk
  • 427
  • 6
  • 15
1
vote
1 answer

disable alphabetically sorting in javadoc

Is there any way that things (e.g. methods) in javadoc don't get rearranged alphabetically? I just want them to appear in the order they also appear in the sourcecode to keep a certain flow when reading through the documentation.
user1052016
1
vote
1 answer

JAXB compile error, unused parameters for afterUnmarshall

I'm using void afterUnmarshal(Unmarshaller unmarshaller, Object parent) in my beans and have got the complier set to fail if parameters are not used. The compiler seems to be okay with unused parameters if I override a superclass/interface that has…
Franz Kafka
  • 10,623
  • 20
  • 93
  • 149
1
vote
1 answer

Eclipse Javadoc error/exception

I am trying to attach the javadoc to Guava in Eclipse. I set the javadoc location to http://guava-libraries.googlecode.com/svn/trunk/javadoc/, the validation passes. When I press F2(force show javadoc) on a Guava class, I get the error below. I am I…
Juxtaposition
  • 646
  • 5
  • 10
1
vote
1 answer

How do I identify instances in Javadoc or pseudo code?

I am tempted to write something as follows: StringBuilder.append(String.format("%d %f", x, y)); But, I know that I am really working with an instance of StringBuilder and I do not mean to be invoking a static append method. Is there a commonly…
H2ONaCl
  • 10,644
  • 14
  • 70
  • 114
1
vote
1 answer

supplying javadoc in "class only" jar file

I am distributing jar file for client as an API jar. I DON'T want them to see my source code (and say 'your code sucks'), but I want them to be able to see the docs (comments /** */ ?). Am I right that I must supply a separate doc.jar file as well…
GaryX
  • 737
  • 1
  • 5
  • 20
1
vote
1 answer

JavaDoc for AbstractQueuedSynchronizer is unclear

Two sentences in the JavaDoc for AbstractQueuedSynchronizer are in my opinion unclear/misleading, and therefore I would like to clarify such issues. The first sentence states: Even though this class is based on an internal FIFO queue, it does not…
Ciaccia
  • 382
  • 3
  • 14
1
vote
2 answers

Getting documention to appear in intellitext window using eclispe and java

When using the standard api, for example the collections library, the predictive text options windows also shows the comments on class/methods. however when I do the same style comments on my own code - the open project I am working on (code…
NimChimpsky
  • 46,453
  • 60
  • 198
  • 311
1
vote
0 answers

Looking for a way to shade and relocate javadocs in my api module using maven (preferably)

I have a minigame that depends on a minigame engine, I am relocating the minigame engine in a sub package of the minigame called engine and also relocating the API part of the engine inside the minigame API. This part works flawlessly, but I want to…
Fr33styler
  • 11
  • 1
1
vote
1 answer

How to merge method and description columns

I'm new to javadoc. I've tried to generate javadoc with Maven plugin. It works well, however, it generates 2 columns Method and Description instead 1 column Method and Description. I can't find option to merge these 2 columns. Here is the config in…
Ngu Duong
  • 11
  • 2
1
vote
2 answers

JavaDoc for Method with Multiple Signatures

Suppose I have a method with multiple signatures (just a silly example). The method with all parameters is the actuall workhorse and all other methods are convenience shortcuts. I have documented the workhorse method using JavaDoc. Since all other…
petermeissner
  • 12,234
  • 5
  • 63
  • 63
1
vote
1 answer

I want to see if there is a efficient method or a way of Optimizing method to Read and insert data faster

The below code takes long to process records My Db has millions of records 1000 records processed Time Taken: 32149s /** * Saves monthly budget accounts to the database. * * @param dto the list of monthly…
DynComplier
  • 13
  • 3
1
vote
0 answers

Maven Javadoc plugin 3.5.0: How do I fix "Unable to derive module descriptor" error?

I am building a Maven project with the maven-javadoc-plugin attached. After updating to maven-javadoc-plugin 3.5.0, this error appears while running the jar goal: Execution build-javadoc-jar of goal…
Geoffrey De Smet
  • 26,223
  • 11
  • 73
  • 120
1
vote
1 answer

I'm using the maven-javadoc-plugin, how can I include documentation from other modules together?

I have two modules, A and B, and A depends on B. They are completely separate, and B is deployed and used in an internal repository. You want to use the maven-javadoc-plugin for documentation in A, but you also want to include the contents of B's…
taetaetae
  • 141
  • 1
  • 6
1
vote
0 answers

How to inspect javadoc comments?

I have a library with three artifacts: lib.jar - the lib lib-sources.jar - sources of the lib lib-javadoc.jar - a javadoc static site of the lib I want to inspect javadoc comments on the lib and to figure out, for example: Do all parameters in…
nik0x1
  • 152
  • 11
1 2 3
…
99
100