Thanks to a lot of research and some answers found here. I have been able to use the javadoc command to generate some html files. My question is, once I have successfully generated these files, where do I place them (directory) so that they show up as javadoc when using my compiled jar library?
Asked
Active
Viewed 273 times
1
-
in the library folder! – Am_I_Helpful Jul 21 '14 at 14:33
-
Can you explain a little more about that. Where like in the root of the library project? – Kyle Jul 21 '14 at 15:58
-
First of all,specify your IDE. If it is NetBeans,I can totally help you,else,I'll try my best! – Am_I_Helpful Jul 21 '14 at 17:47
1 Answers
1
Most IDEs allow you to select a JAR and then set the folder or JAR which contains the javadoc in a properties dialog.
That said, javadoc is only useful when it was created with a lot of care. Most of the time, the sources are much more useful (especially since sources can't lie, they contain all the corner cases, people are used to read source code and most developers are very, very bad at writing documentation).
All IDEs I know (Eclipse, IDEA, Netbeans) can extract javadoc from a JAR which contains the sources at runtime.
Aaron Digulla
- 321,842
- 108
- 597
- 820
-
Ok so I would have to distribute the folder with the jar, and devs would have to select it from within their IDE. There is no way to include it with the JAR to begin with? – Kyle Jul 21 '14 at 16:10
-
There is no way to include it in the JAR but you can package all the files in a JAR, so developers just have to deal with two JAR files. – Aaron Digulla Jul 22 '14 at 07:16
-
-
@Kyle: I can't answer that in a comment. Ask a new question for that. – Aaron Digulla Jul 23 '14 at 09:11