How should one distribute the Javadoc for a Library?

后端 未结 3 1268
一向
一向 2021-02-05 07:32

I am writing a custom library. It\'s build into a .jar archive. I am fully able to generate the javadoc, but I don\'t know how I should distribute it?

  1. Put it in th
3条回答
  •  自闭症患者
    2021-02-05 07:59

    It's a general practice to keep the JavaDocs in a separate archive. or even more commonly, in a directory called 'docs'. you do not needlessly want to bloat your library's archive with the html and js files.

    And why would you want to include the generated JavaDocs [html + js] in your project? As long the source code JavaDoc comments are in place, someone using your library will be able to see them by simply hovering over w/ the mouse in any of the modern IDE's

    Update
    As per nanda's comment below, I checked the same and he IS correct. In my project, I have actually attached Javadocs from the 'doc' folder to the archive to be able to view them on mouseover.

提交回复
热议问题