2 Replies Latest reply: Apr 15, 2013 9:24 AM by techwriter65 RSS

    including custom html files in generated javadoc output

    techwriter65
      Can custom files be included in javadoc output?

      I need to create a file (html i assume) that explains how to use example programs; I can't find any info on processing custom files in the "javadoc API doc generator", but there must be a way.

      Where do i store a custom file, and is there an option I need to specify?

      running ADT v21.1.0-569685 and JDK v6

      Thanks
        • 1. Re: including custom html files in generated javadoc output
          thomas.behr
          Well, either treat your explanation as regular documentation and mention it in overview/package/class documentation (as appropriate) or simply add a link to your overview/package/class documentation that references the HTML file with your explanation. In the latter case, it should be possible to use a relative path since you can always copy the external HTML file into the directory structure created by javadoc. See http://docs.oracle.com/javase/1.5.0/docs/tooldocs/windows/javadoc.html#overviewcomment for information on overview comments and http://docs.oracle.com/javase/1.5.0/docs/tooldocs/windows/javadoc.html#packagecomment for information on package comments.
          • 2. Re: including custom html files in generated javadoc output
            techwriter65
            Thanks for the reply.

            I was trying to get the javadoc tool to include the custom file in the generated output, but simply referencing it from the overview file and copying to the directory as you suggested makes perfect sense. I'll try it.

            Thanks!