From 12a3f55e4faf24bf06c8a5e3eb84fe252e77f30a Mon Sep 17 00:00:00 2001 From: Norman Walsh Date: Sun, 17 Jun 2001 16:44:14 +0000 Subject: [PATCH] Initial revision --- jrefentry/README.xml | 181 ++++++++++++++++++++++++++++++++++++ jrefentry/jrefentry.dtd | 197 ++++++++++++++++++++++++++++++++++++++++ 2 files changed, 378 insertions(+) create mode 100644 jrefentry/README.xml create mode 100644 jrefentry/jrefentry.dtd diff --git a/jrefentry/README.xml b/jrefentry/README.xml new file mode 100644 index 000000000..520903636 --- /dev/null +++ b/jrefentry/README.xml @@ -0,0 +1,181 @@ + +
+README for the JRefEntry DTD V1.0 +2000Norman Walsh + +Java and JavaDoc are registered trademarks of +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 tag + JRefEntry element + + + + + purpose (contextual) + refpurpose + + + description (contextual) + refdescription + + + @author + refauthor + + + @version + refversion + + + @param + refparameter + + + @return + refreturn + + + @exception + refexception + + + @throws (alternate for @exception) + refthrows (alternate for refexception) + + + @see + refsee + + + @since + refsince + + + @serial + refserial + + + @deprecated + refdeprecated + + + + + +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. + + +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 +Description]]>. + + +
+
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: + + + +]]> + +
+ +
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 V4.0 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 Norman Walsh, +ndw@nwalsh.com. + +The best way to reach norm is by email. You will find additional +contact information at +http://nwalsh.com/~ndw/contact.html. + +
+
+ diff --git a/jrefentry/jrefentry.dtd b/jrefentry/jrefentry.dtd new file mode 100644 index 000000000..200e864c6 --- /dev/null +++ b/jrefentry/jrefentry.dtd @@ -0,0 +1,197 @@ + + + + + + + + +%docbook; + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + -- 2.40.0