[dbdoclet] Re: Reference book type

Hello Jere,

I have realized a beta version of dbdoclet.jar, which creates an 
experimental "refentry" book. I also fixes the problem with the constant 
field value section and the appendix is suppressed now by default. You 
can download it from http://www.dbdoclet.org/downloads/dbdoclet-0.64b2.jar.

The changelog so far:

2005-03-18 Release 0.64

    * The new property doclet.book-type controls which type of book
    should be created. Two type of books are supported: book and
    reference.  The first creates a book, chapters structure and the
    second a reference, refentry one.

    * Renamed the property doclet.style.flavour to doclet.style.type
    (--style-type).
   
    * The new property doclet.use-appendix (--use-appendix) controls
    whether appendix components should be used or not. The default is
    to use only chapters. When this flag is set, certain parts of the
    document will be created as appendix.

    * If constant field values are of type java.lang.String, they are
    surrounded by double quotes now.

    * Fixed spurious whitespace in para and xref tags.

    * Fixed missing id in table tag.

    * Fixed erroneous entity handling in constant values section.

Regards
Michael

Jere.Kapyaho@xxxxxxxxx schrieb:

>Hi Michael,
>
>the strict style does indeed generate "proper" classsynopsis-style =
>markup - I missed this initially, although it is in the dbdoclet =
>documentation.
>
>In a larger context, I have been thinking that maybe Java API =
>documentation should actually also use the reference markup instead of =
>plain chapter/sect1 markup.
>
>The end result would be something like this (with examples from dbdoclet =
>documentation):
>
><reference id=3D"PACKAGE-1" xreflabel=3D"org.dbdoclet.doclet">
>  <title>Package org.dbdoclet.doclet</title>
>  <partintro><para>The package org.dbdoclet.doclet contains the =
>following classes: ...</partintro>
>
>  <refentry id=3D"CLASS-1-1" =
>xreflabel=3D"org.dbdoclet.doclet.ClassDiagramManager">
>    <refnamediv>
>      <refname>Class ClassDiagramManager</refname>
>      <refpurpose>The class ClassDiagramManager. (first sentence of =
>JavaDoc class
>description)</refpurpose>
>    </refnamediv>
>    <refsynopsisdiv>
>      <classsynopsis class=3D"class" language=3D"java">
>        <ooclass>
>          <classname>ClassDiagramManager</classname>
>        </ooclass>
>        <constructorsynopsis language=3D"java">
>          <modifier>public</modifier>
>          <methodname>ClassDiagramManager</methodname>
>          <methodparam>
>            <type>DocletOptions</type>
>            <parameter>options</parameter>
>          </methodparam>
>        </constructorsynopsis>
>      </classsynopsis>
>    </refsynopsisdiv>
>    <!-- ... -->
>    <refsection>
>      <title>Declaration</title>
>      <para><literal>ClassDiagramManager</literal></para>
>    </refsection>
>    <refsection>
>      <title>Description</title>
>      <para>The complete class description.</para>   =20
>    </refsection>
>    <refsection role=3D"constructorlist">
>      <title>Constructors</title>
>      <refsection id=3D"CONSTRUCTOR-1-1-1">
>        <title>ClassDiagramManager</title>
>        <refsection>
>          <title>Declaration</title>
>          <para><literal>public ClassDiagramManager</literal></para>
>        </refsection>
>        <refsection>
>          <title>Description</title>
>          <para>Method description goes here.</para>
>        </refsection>
>      </refsection>
>    </refsection>
>    <!-- ... -->
>  </refentry>
></reference>
>
><reference id=3D"PACKAGE-2" xreflabel=3D"org.dbdoclet.doclet.docbook">
><!-- and so on -->
></reference>
>
>This is not a complete example, but I think you get the idea. The main =
>thing is that there would be one reference per package, with one =
>refentry per class/interface/exception. There would also be one =
>refsection for constructors, another for fields, and another for =
>methods. I think this is closer to the HTML that the JavaDoc tool =
>produces.
>
>I have been dabbling with a doclet that emits markup like this, but I =
>would like to know if there is any chance of dbdoclet evolving in this =
>direction before committing to developing that further.
>
>If you are interested, I can supply a more comprehensive example. I am =
>currently working on the PDF version of JSR-238 and I need to get a =
>solution within a few weeks, so I probably need to hack something =
>together, but I am willing to contribute the general design of this =
>approach if you think it is feasible.
>
>Best regards,
>Jere
>  
>

Other related posts: