Forum Stats

  • 3,838,708 Users
  • 2,262,394 Discussions
  • 7,900,739 Comments

Discussions

Javadoc: including external HTML file that's rendered

I have some long tables that I'd like to link to in the Javadoc, but I don't want them cluttering the main documentation. They are reference only.

I've formatted the tables in an external HTML file. I created a doc-files directory and placed the HTML file there. If I just link to it with an HTML a tag, I just see the HTML code. How can I get the Javadoc compiler to render it?

I know how to include images. I also created an overview.html file and got that to work. But I failed to figure out how to do this. The long tables would be inappropriate in the overview or package descriptions.

I did look at this, which made me think I could do it, but I was unable to figure it out:

https://docs.oracle.com/javase/1.5.0/docs/tooldocs/windows/javadoc.html#unprocessed

Maybe it can be done with JavaScript or a javadoc compiler argument? I tried the former but it didn't work for me -- maybe I did it incorrectly. More info:

bugs.eclipse.org/bugs/show_bug.cgi?id=228608

w3schools.com/howto/howto_html_include.asp

https://docs.oracle.com/javase/1.5.0/docs/tooldocs/windows/javadoc.html#options

I'm creating Javadoc in Eclipse and use ant to compile it. I'm using SE 1.7.

Thanks for any help you can provide.

Best Answer

Answers

This discussion has been closed.