Doclet: Difference between revisions

From unkrig.de
Jump to navigation Jump to search
 
(8 intermediate revisions by the same user not shown)
Line 1: Line 1:
<meta name="keywords" content="java, doclet"></meta>
<meta name="description" content="Several useful doclets for use with JAVADOC"></meta>
This site makes several doclets publicly available which I wrote for my personal needs, but are hopefully useful for others. Enjoy!
This site makes several doclets publicly available which I wrote for my personal needs, but are hopefully useful for others. Enjoy!
== The CheckStyle Doclet ==
Generates MEDIAWIKI-format documentation for [http://checkstyle.sf.net CheckStyle] and [http://eclipse-cs.sf.net Eclipse-CS] plugin-ins.
The motivation for writing this doclet was to ease the maintenance of the documentation for the [[Cs-contrib.unkrig.de]] CheckStyle plug-in. See [[Cs-contrib.unkrig.de_/_Checks_/_Name_spelling|here]] for an example generated page.
The generation of MEDIAWIKI documentation will be replaced with (JAVADOC-like) HTML documents.
=== Resources ===
Find the jar file [http://unkrig.de/doclet/cs/download/ here].
Find the source code for the doclet [https://svn.code.sf.net/p/loggifier/code/trunk/de.unkrig.doclet.cs here].
Find the documentation [[Cs-doclet|here]].


== The ANT Doclet ==
== The ANT Doclet ==
Line 21: Line 7:
Generates (JAVADOC-like) HTML documentation for [http://ant.apache.org APACHE ANT] antlibs.
Generates (JAVADOC-like) HTML documentation for [http://ant.apache.org APACHE ANT] antlibs.


The motivation for writing this doclet is to ease the maintenance of the documentation for the [[Ant-contrib.unkrig.de]] antlib.
The motivation for writing this doclet is to ease the maintenance of the documentation for the [[Antology]] antlib.


It is not (yet) completely functional.
[[ANT doclet|Read more...]]


=== Resources ===
== The CheckStyle Doclet ==


Find the source code for the doclet [https://svn.code.sf.net/p/loggifier/code/trunk/de.unkrig.doclet.ant here].
Generates (JAVADOC-like) HTML documentation and the metadata files for [http://checkstyle.sf.net CheckStyle] and [http://eclipse-cs.sf.net Eclipse-CS] plugin-ins from "doc tags" in the source code of your checks and filters.


[[Cs-doclet|Read more...]]


== The JAVADOC Doclet ==
== The JAVADOC Doclet ==


A drop-in replacement for the standard JAVADOC doclet that is part of the JAVADOC utility which ships with the JDK.
A re-implementation of the JAVADOC standard doclet, basically a reference to show how to use [https://github.com/aunkrig/no-template the "no-template" framework].


The main motivation was to develop a slick framework the would help me (and others) to implement other doclets (see below) more easily. After all, JAVADOC is *the* reference application of a doclet, and anybody who wants to write a doclet knows it and has an idea of how to get from the JAVADOC doclet to *his* doclet.
[[JAVADOC doclet|Read more...]]
 
=== Getting started ===
 
To use my JAVADOC doclet, you must run the JAVADOC utility exactly as usual, but pass <code>-doclet</code> and <tt>-docletpath</tt> command line options to replace the built-in doclet with mine.
 
=== Resources ===
 
Find the source code [https://svn.code.sf.net/p/loggifier/code/trunk/de.unkrig.doclet.javadoc here].
 
Ready-to-use binaries are not (yet) available.


== The MAIN Doclet ==
== The MAIN Doclet ==


This doclet creates a (very simple) HTML page for the "'''main(String[])'''" method (or a different method) of each of the specified classes.
Generates an HTML page for the <code>main(String[])</code> method (or any other method) of each of the specified classes. This is useful for command line tools with a set of command line options. Converted to plain text (e.g. with the [[html2txt]] utility), that documentation is perfect for a self description that a command line utility would print in response to <code>--help</code>.
 
=== Doclet options ===
 
; -d ''dest-dir''
: Where to create the output files. The complete output file name is "''dest-dir''/pkg/pkg/class.meth(int, String)".
 
; -method ''method-signature''
: Which method to document; defaults to "'''main(String[])'''".
 
; -output-encoding ''enc''
: The encoding to use when writing output files; defaults to the "JVM default charset".
 
=== Resources ===
 
Find the source code [https://svn.code.sf.net/p/loggifier/code/trunk/de.unkrig.doclet.main here].


Ready-to-use binaries are not (yet) available.
[[MAIN doclet|Read more...]]

Latest revision as of 16:47, 12 February 2017

<meta name="keywords" content="java, doclet"></meta> <meta name="description" content="Several useful doclets for use with JAVADOC"></meta> This site makes several doclets publicly available which I wrote for my personal needs, but are hopefully useful for others. Enjoy!

The ANT Doclet[edit]

Generates (JAVADOC-like) HTML documentation for APACHE ANT antlibs.

The motivation for writing this doclet is to ease the maintenance of the documentation for the Antology antlib.

Read more...

The CheckStyle Doclet[edit]

Generates (JAVADOC-like) HTML documentation and the metadata files for CheckStyle and Eclipse-CS plugin-ins from "doc tags" in the source code of your checks and filters.

Read more...

The JAVADOC Doclet[edit]

A re-implementation of the JAVADOC standard doclet, basically a reference to show how to use the "no-template" framework.

Read more...

The MAIN Doclet[edit]

Generates an HTML page for the main(String[]) method (or any other method) of each of the specified classes. This is useful for command line tools with a set of command line options. Converted to plain text (e.g. with the html2txt utility), that documentation is perfect for a self description that a command line utility would print in response to --help.

Read more...

Retrieved from "https://unkrig.de/STRATO-apps/mediawiki_03/app/index.php?title=Doclet&oldid=944"