javadoc

I would like to have the javadoc comments contained in a jar file show in eclipse when I hover over a class. For example, after downloading JODA-2.0, three jars are obtained: joda-time-2.0 joda-time-2.0-javadoc joda-time-2.0-sources ( http://sourceforge.net/projects/joda-time/files/joda-time/2.0/joda-time-2.0-dist.zip/download ) In eclipse, [right click project -> Properties -> Java Build Path -> Libraries -> ADD JARs...] includes the binary in the project (can reference those classes) for joda-time-2.0.jar. But how can I link in the sources/javadoc comments contained in the other two jar

What convention do you use to comment getters and setters? This is something I've wondered for quite some time, for instance: /** * (1a) what do you put here? * @param salary (1b) what do you put here? */ public void setSalary(float salary); /* * (2a) what do you put here? * @return (2b) */ public float getSalary(); I always find I'm pretty much writing the exact same thing for 1a/b and 2a/b, something like 1a) Sets the salary of the employee, 1b) the salary of the employee. It just seems so redundant. Now I could see for something more complex you might write more in the (a) parts, to give

How do I create custom javadoc tags such as @pre / @post? I found some links that explain it but I haven't had luck with them. These are some of the links: http://www.developer.com/java/other/article.php/3085991/Javadoc-Programming.html http://java.sun.com/j2se/1.5.0/docs/tooldocs/windows/javadoc.html java code /** * @custom.mytag hey ho... */ java doc option -tag custom.mytag:a:"This is my Tag:" output This is my Tag: hey ho... Custom tags should not be created using HTML because javadoc might change it's implementation or how it presents data, maybe they'll start using Markdown in the future

I'm wondering about best practices when creating Javadocs. I have a project with many files. Code has been created by many developers. Each file has an annotation @author , so it is obvious who has created a particular class. But when some other developer adds new code to a file, modifies it, etc., how should he inform the rest of the team that he has created some new function or has modified existing code? In other words, how should we "keep the Javadocs compatible with reality"? ;) Add his name to the existing @author tag? Then, it is easier to identify who to ask in case of any doubts. Add

When using the Android support library for compatibility and try to view the javadoc for, say, FragmentTransaction , I get the following error because there is no associated javadoc file: android.support.v4.app.FragmentTransaction Note: This element neither has attached source nor attached Javadoc and hence no Javadoc could be found. The support library is added under the Android Dependencies item in the project properties, and shows Javadoc location: (None) - non-modifiable as shown below. Is there any workaround for this? NickT I've lashed together a project with android-support-v4.jar just

I'm currently working with an XML Schema that has <xsd:annotation> / <xsd:documentation> on most types and elements. When I generate Java Beans from this XML Schema, then the Javadoc of those Beans only contains some generic generated information about the allowed content of the type/element. I'd like to see the content of the <xsd:documentation> tag in the relevant places (for example the content of that tag for a complextType should show up in the Javadoc of the class generated to represent that complexType). Is there any way to achieve this? Edit : this XML Schema will be used in a WSDL

I need a code documentation tool similar to javadoc or c# xml doc for delphi code. What is the best tool? I prefer a technology, which is in the future compatible to the Microsoft sandcastle project. Arnaud Bouchez Take a look at SynProject , an Open Source tool written in Delphi. It was designed to handle a full documentation workflow, from specifications to release notes, including tests, architecture and design; and of course there is an integrated Delphi parser to generate architecture documentation from existing Delphi source code. For the architecture document, the source code can