javadoc

I'm documenting a Java program that I have developed, and wanted to know if JavaDoc will be generated for an inherited method (which is overridden) if I just document the superclass? If I have a class called Vehicle with a drive() method in, and a sub-class called Car with the drive() method overridden, will the documentation for the Vehicles drive method be included in the Cars drive method if no Javadoc is put in the Car class? [I] wanted to know if JavaDoc will be generated for an inherited method (which is overridden) if I just document the superclass? Yes. If you don't have javadoc

Should I write JavaDoc for private or protected methods? And what about private variables? I see class examples on my Java book and the private variables are JavaDoc'ed. So I can't understand if it is a good practice to JavaDoc the private (or protected ) methods. AlexWien Yes you should write JavaDoc for private methods, and even when it is only for yourself. In 3 years when you have to change the code, you will be happy that you documented it. If you leave the company, or have to work on another project, your co-workers will be happy to have a documented code. Undocumented code has much

In OpenJDK, for the method: public static Double valueOf(double d) The javadoc says: Returns a Double instance representing the specified double value. If a new Double instance is not required, this method should generally be used in preference to the constructor Double(double), as this method is likely to yield significantly better space and time performance by caching frequently requested values. Here's the actual code: public static Double valueOf(double d) { return new Double(d); } The cache is a lie! What's going on here? The method exists for many types: Integer , Long , BigDecimal and

Is it possible to set up Intellij to generate javadoc for methods and classes, automatically, with @author and @since date ? I had this feature in Eclipse. I know, that files have templates and also i can manually semi-automatically add javadoc to selected method/class. But i want the generation to be automatic for every generated method/class/enum/interface/field etc. This is useful for e.g. "extract method", "override/implement", "create getter/setter" etc. This would save hundreds of manual actions. I'm using IntelliJ Idea 9.0 BETA Community Edition, #IC-90.96. TIA. It's not possible at the

I've created an API that I release as a JAR file. It's proprietary so I had to strip the source files out of it. I currently include a separate /doc folder which contains the output of Eclipse's export-to-javadoc wizard. Not bad, but I'd like to go one step further. I'd like to distribute the javadocs as a jar file that can be easily dropped into a future project which includes the jar file for my API. I know I've seen it done this way several times with other distributions I've used, but I haven't had any luck searching. End goal is to allow future developers to have easy access to hover over