Add a custom header and footer to standard Javadoc output

Is there an "easy" way to build a custom header and footer and add it to the standard HTML file output from Javadoc?

For example, I need to place tags in my Java source files to designate variable data I want to include along with the standard Javadoc output. The new tags would appear similar to the following:

/**

@security.line1PROPRIETARY

@security.line2FOR INTERNAL USE ONLY

@security.projectNameA PROJECT WE WANT

@security.contractStatusBIDDING

@security.contractDate10 APRIL 2006

*/

I then want to parse these custom tags and add a header and footer to the standard Javadoc output similar to the following:

PROPRIETARY

FOR INTERNAL USE ONLY

A PROJECT WE WANT

{ Standard JavaDoc output }

A PROJECT WE WANTContract Status: BIDDING

Contract Bid Date: 10 APRIL 2006

FOR INTERNAL USE ONLY

PROPRIETARY

Will you please provide me a link to some sample code for doing so? Your help will be greatly appreciated.

Thanks in advance,

Phil Bryant

philbryant@merc.mercer.edu

phillip.bryant@robins.af.mil

<><

[1156 byte] By [plbryanta] at [2007-10-2 16:40:39]
# 1

I suggest to look at this tool:

http://www.filigris.com/products/docflex_javadoc/

This is a template-driven doclet able to generate both HTML and RTF output with powerful capabilities for any customizations.

Some people told us this tool saved them huge a lot of time!

If you have any questions about it, we are glad to hear.

Thanks,

Leonid Rudy

http://www.docflex.com

leonid_rudya at 2007-7-13 17:49:14 > top of Java-index,Developer Tools,Debugging and Profiling Tool APIs...
# 2
You can use -bottom option for text that goes at the bottom.In JDK 6.0 there might be a new -top option for text that goesat the top. https://mustang.dev.java.net/Or you could use -header for the top.-Doug
dhkramera at 2007-7-13 17:49:14 > top of Java-index,Developer Tools,Debugging and Profiling Tool APIs...
# 3

The <javadoc> Ant task has a footer attribute (maybe header, too?) that can do that. Here's one I use to put a date-time stamp at the bottom of each page:

<javadoc

...

footer="<script>document.write('<p class="footer">' + document.lastModified + '

')</script>"

>

Dick_Adamsa at 2007-7-13 17:49:14 > top of Java-index,Developer Tools,Debugging and Profiling Tool APIs...
# 4
The forum software scrambled my input. You'll have to use the XML character entites gt & lt instead of the angle brackets for it to work.
Dick_Adamsa at 2007-7-13 17:49:14 > top of Java-index,Developer Tools,Debugging and Profiling Tool APIs...