javadoc

问题 I have the following: <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <version>${maven-javadoc-plugin.version}</version> <executions> <execution> <id>javadoc-jar</id> <phase>package</phase> <goals> <goal>jar</goal> </goals> </execution> </executions> </plugin> Which works fine during packaging or installing: mvn install or mvn package, however, as soon as I try to specify a TestNG Group to run for the tests: mvn install -Dgroups=somegroup it

问题 I am trying to add a JavaDoc in my code. I need to add multiple exception in a single throw. When I add below, it only recognizes NullPointerException not the IllegalArgumentException . Is there any way to provide multiple exception in a single throw tag so that it can recognize both, when I place my mouse on the method? @throws NullPointerException, IllegalArgumentException when invalid userId, timeout is passed Or I need to do it like this? By this, I am repeating same comment twice.

问题 This question already has answers here : codestyle; put javadoc before or after annotation? (5 answers) Closed 6 years ago . I've looked across this forum, and I've googled this one, and I'm not sure what is the best way to handle Javadoc and annotations that appear together in the same class. From what I can see from Sun/Oracle's documentation, they seem to suggest (though I cannot really find an explicit statement) that Javadoc should be listed atop annotations. See their example How and

问题 Some of my colleagues lack discipline and not always write documentation of their classes(not always = never). I was trying to force them to write documentation by setting project warnings for missing comment javadocs. We got two source folders 'src' and 'tests' - obviously not all @Test methods needs documentation and this warning there is redundant. But now all undocumented tests got these annoying warnings, the project got hundreds of warnings and I'm afraid that some real dangerous

问题 I have written a lot of comments inside my business logic like that: /** * Do some important stuff. * @param pDog * @param pAllDogTraining * @return */ @Overwrite public Map<DogId, Dog> doEvaluateAllDog(final Dog pDog, final Collection<DogTraining> pAllDogTraining) { final Map<DogId, Dog> lAllDogBad = new HashMap<DogId, Dog>(); final List<DogTraining> lAllDogTraining = new ArrayList<DogTraining>(pAllDogTraining); /** * Remove deleted entries. * Detailed description */ removeDeletetTrainings

问题 Let's say I have the following function: /** * Thorough explanation * */ public void somethingImportant(String parameter) { (...) } Now for convenience, I add the following function: public void somethingImportant() { somethingImportant(null); } The javadoc for both functions should be next to identical. Perhaps the only difference is that the first function has an extra line describing what parameter does. Is there any way to avoid simply copying the existing javadoc, and instead reusing it?

问题 Closed. This question is off-topic. It is not currently accepting answers. Want to improve this question? Update the question so it's on-topic for Stack Overflow. Closed last year . I want to generate javadocs through maven's site generation plugin and I want to have automatic UML diagrams created and embedded in the javadoc. The statsvn project uses yDoc to generate their UML documentation but I think they're using Maven1. yDoc is a commercial shareware product, so I'm unsure how the open

问题 Suppose I have two classes: abstract class GenericA<E> { public void go(E e) {...} } public class IntegerA extends GenericA<Integer> { } Note that GenericA is package-private and generic, and IntegerA is public and not generic. Now, when I generate the public Javadoc (using Eclipse), I see the following in the IntegerA methods section: public void go(E e) The problem is that a reader of that Javadoc has no idea what E is; i.e., that E represents Integer . I would rather have the Javadoc say

问题 I am trying to create javadoc for my client library. In MyOtherClass, I put the the below @see , and get warnings. MyOtherClass and MyClass both are in different packages, in the same project. @see MyClass#Constructor(Type1 param1, Type2 param2) warning - Tag @see: reference not found: MyClass#Constructor(Type1 param1, Type2 param2) Then I tried @see MyClass#MyClass(Type1 param1, Type2 param2) warning - Tag @see: reference not found: MyClass#MyClass(Type1 param1, Type2 param2) Also tried @see

问题 When a class overrides a concrete method or implements and abstract method, the Javadoc is automatically inherited unless explicitly overwritten. Or, at least the tool tries to do this. It seems it does not work for linked external APIs. For instance, when I in my code implement java.util.Map , or something else from the JRE, the javadocs are not inherited/copied from the JRE javadocs/apidocs. In my specific case, I am trying to configure this in the Maven2 Javadoc plugin, but it is the same