CODEWITHSUNDEEP
javaintellij-ideajavadoc
JensV
JensV

Reputation: 4524

Write JavaDocs for external library

My situation is I have an external compiled library (jar) from a 3rd party with no JavaDocs. As I'm developing I want to document the classes and methods by testing and using the very limited documentation I get from the website of the 3rd party.

My end goal is to have a JavaDoc documentation which I will be able to use in IntelliJ for the Code-Hinting and documentation lookup?

So my question is, is it possible to write JavaDocs to a already compiled jar file which I will be able to import? Perhaps using a tool which assists this.

Upvotes: 8

Views: 1442

Answers (1)

user207421
user207421

Reputation: 310859

Yes it is. All you have to do is write out the class and interface and method and variable definitions, without any code, as though all the methods were abstract, and then write Javadoc comments for those. This is actually how Sun produced the Javadoc, via a completely separate source tree controlled by the technical writers and editors (hi Doug!), with a merge process late in the build process for releasing the source code.

Upvotes: 4

Related Questions