java - How should one distribute the Javadoc for a Library? -


i writing custom library. it's build .jar archive. able generate javadoc, don't know how should distribute it?

  1. put in same .jar library
  2. put in different .jar
  3. some other way?

and how include javadoc in project uses lib?

  1. if had put in same .jar, should have written in manifest?
  2. if it's in separate .jar, including in project enough?

i using netbeans 9.1.

i'd include library .jar , documentation , other things, readme, license file etc. in single archive (zip or tar.gz)

mylib-1.0.1.tar.gz , contains:

mylib-1.0.1/            ├── javadoc            │   └── index.html  (and other javadoc files under here)            ├── mylib-1.0.1.jar            └── readme 

instead of expanded javadoc/ sub directory within archive, add compressed javadoc in mylib-1.0.1-javadoc.jar (or zip) , both options common.

mylib-1.0.1/            ├── mylib-1.0.1-javadoc.jar            ├── mylib-1.0.1.jar            └── readme 

Comments

Popular posts from this blog

ASP.NET/SQL find the element ID and update database -

jquery - appear modal windows bottom -

c++ - Compiling static TagLib 1.6.3 libraries for Windows -