Index of /ProgramDocuments/jrefentry

      Name                    Last modified       Size  Description

[DIR] Parent Directory 09-Jan-2008 17:38 -

README for the JRefEntry DTD V1.1

README for the JRefEntry DTD V1.1

Java and JavaDoc are registered trademarks of

Google

Sun Microsystems, Inc.


This is a customization of the DocBook RefEntry model. The purpose of this customization is to mirror the order and nature of structured comment tags in JavaDoc documentation.

Overview

JavaDoc comments for a consist of a purpose followed by a description followed by additional, optional tags. This structure is modelled by JRefEntry as follows:

JavaDoc tagJRefEntry element
purpose (contextual)refpurpose
description (contextual)refdescription
@authorrefauthor
@versionrefversion
@paramrefparameter
@returnrefreturn
@exceptionrefexception
@throws (alternate for @exception)refthrows (alternate for refexception)
@seerefsee
@sincerefsince
@serialrefserial
@deprecatedrefdeprecated

Within sections that would normally be repeated (e.g., @param), use a variablelist for each individual item. To break the items into groups, use separate lists.

Note

The content models of each of these special sections are designed so that the could easily be mapped to a normal DocBook refentry. For example, <refdescription> could easily be mapped to <refsect1><title>Description</title>.

Manifest

README

This readme file.

jrefentry.dtd

The JRefEntry DTD. It is built on top of the XML version of DocBook V4.0.

Installation

Place the files in this distribution somewhere on your machine. Adjust your catalog(s) if appropriate (XML tools frequently do not support catalogs, so this may be irrelevant for you).

Please use the following formal public identifier to identify this DTD:

  -//Norman Walsh//DTD JRefEntry V1.0//EN

For example, to write a JRefEntry document, you might use this DOCTYPE declaration:

<!DOCTYPE refentry
          PUBLIC "-//Norman Walsh//DTD JRefEntry V1.0//EN"
                 "http://nwalsh.com/docbook/jrefentry/1.0/jrefentry.dtd">

Copyright


JRefEntry DTD V1.0
Copyright © 2000 Norman Walsh
http://nwalsh.com/docbook/jrefentry/

You may distribute this DTD under the same terms as DocBook.

Please direct all questions and comments about this DTD to Norman Walsh, <ndw@nwalsh.com>.

This DTD is based on DocBook XML V4.1.2 from OASIS.

For more information about the DocBook DTD, see http://www.oasis-open.org/docbook/.

Warranty

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL NORMAN WALSH OR ANY OTHER CONTRIBUTOR BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Contacting the Author

This DTD is maintained by the DocBook Open Repository team on SourceForge.