Results 1 to 1 of 1
Thread: Javadoc -header option
- 11-07-2010, 06:23 AM #1Member
- Join Date
- Apr 2009
- Rep Power
Javadoc -header option
I need to add a message to the top of every Javadoc page in my client's project. The source code is generated from a WSDL, so I can't add the message directly, and it's not feasible to modify the generation tool.
I want to use the Javadoc tool's -header option to add the message, but the tool formats the pages in a way that makes that technique unusable. It composes the top of the page with a two-column table. The first column contains the link bar (the shaded area with “Overview, Package, Class...” links). The second column contains the header text. The table is formatted so that the link bar occupies most of the page width.
When I first saw this, I thought, "It's as though the header was meant to be invisible!" I was feeling snarky, but I looked at the official Javadoc pages for the JDK, and I realized that it's literally true. On those pages the header is used to display a message like "Java™ 2 Platform Std. Ed. v1.4.2," which contains significant information, but just has to be there if the user goes looking for it. My message, in contrast, contains information that a new user would not think to look for, but not knowing it would cost her dearly in time and frustration. It has to be made as visible as it can be without becoming a distraction.
Is there a way to control the composition of the header text; specifically, to make it appear in a full page width column? Or, is there an alternative way of introducing text through the Javadoc tool that would accomplish what I want?
- By Quirl in forum New To JavaReplies: 2Last Post: 07-28-2010, 11:19 PM
- By Talkinjive in forum Web FrameworksReplies: 0Last Post: 01-31-2010, 05:15 PM
- By selva.bics in forum New To JavaReplies: 0Last Post: 11-26-2009, 03:26 PM
- By Java Tip in forum Java TipReplies: 0Last Post: 11-26-2007, 02:30 PM
- By bbq in forum AWT / SwingReplies: 1Last Post: 07-05-2007, 05:11 AM