XmlDoclet Files

License
-------

Copyright (c) 2016, Georg Ulbrich
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this
   list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice,
   this list of conditions and the following disclaimer in the documentation
   and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

The views and conclusions contained in the software and documentation are those
of the authors and should not be interpreted as representing official policies,
either expressed or implied, of the FreeBSD Project.

Description
-----------

XmlDoclet is a JavaDoc doclet that outputs information in XML format.
You might want to learn how to setup custom doclets.
Also, you might want to understand the com.sun.javadoc package, which is here

    https://docs.oracle.com/javase/8/docs/jdk/api/javadoc/doclet/com/sun/javadoc/package-summary.html

The XmlDoclet is basically a wrapper around the elements of this package,
and the wrapper types are serialized using JAXB.

Usage
-----

1) Place the xmldoclet-<version>.jar and a recent tools.jar into the classpath.
2) Start javadoc, for example from an Ant target, such as

        <javadoc doclet="de.georgulbrich.xmldoclet.XmlDoclet" docletpath="${dist.jar}">
            <classpath>
                <path path="${javac.classpath}"/>
            </classpath>
            <fileset dir="${src.dir}" excludes="${bug5101868workaround},${excludes}" includes="${includes}">
                <filename name="**/*.java"/>
            </fileset>
            <arg line="-xml ${basedir}/${build.dir}/xmldoclet.xml"/>
            <arg line="-noSourcePositions"/>
            <arg line="-noComments"/>
        </javadoc>

3) The doclet class is "de.georgulbrich.xmldoclet.XmlDoclet".
4) The available options to the doclet are

    -xml <filename>     writes the output to the given file instead of STDOUT
    -noSourcePositions  drops source positions from output
    -noComments         drops comments and tags from output

5) The build process for the XmlDoclet has as a final action an application
of the doclet to its own source code, just to demonstrate the basic workings.

Release Notes v0.9
------------------

+ first release
+ known bugs: irregularities regarding tags in comments