...
You can also add any of the following tags at the beginning of the topic title to represent modifications: "{new}","{updated}","{todo}".
For example:
juneau-build-javadoc launcher
The juneau-build-javadoc launcher is then used to construct the overview.html file:
The launcher runs does the following:
- Runs the DocGenerator
...
- class found in the
...
- juneau-doc
...
- project.
Here's what it does:- Renames the file and directory names of the topics so that they're in sequential order. So for example, if you want to add a new topic file, just add it with a number close to where you want it inserted and it will insert it for you.
- Generates the Table of Contents section.
- Generates the contents of the docs.txt file. This allows you to insert topic links in your HTML through the use of doc taglets described below.
- Replaces strings (to simplify "{@link xxx}" tags):
- "oaj"→"org.apache.juneau"
- "oajr"→"org.apache.juneau.rest"
- "oajrc"→"org.apache.juneau.rest.client"
- Constructs the contents of overview.html using the template file overview-template.html
- Runs "mvn javadoc:aggregate" to build the javadocs.
- Runs DocLinkTester class which checks all the generated javadocs for any broken links (e.g. missing images, etc...).
- Copies the generated Javadocs to the /juneau-website/content/site/apidocs-$JUNEAU_VERSION folder so that they're ready to upload to the website.
Taglets
Two custom taglet classes are provided for you:
...