From mboxrd@z Thu Jan  1 00:00:00 1970
From: Bill Brooks <wbrooks@lug.ee.calpoly.edu>
To: docbook-tools-discuss@sourceware.cygnus.com
Subject: marking up Java constructors in docbook
Date: Wed, 27 Dec 2000 06:36:00 -0000
Message-id: <Pine.LNX.4.10.10007171529300.12345-100000@lug.calpoly.edu>
X-SW-Source: 2000/msg00283.html

Hi,

How are people doing API-level documentation in DocBook? 

My immediate need is to produce some documentation of a Java class, in the
same way that JavaDoc does, but I need it to play nice inside an overall
DocBook manual, so just inserting the HTML that javadoc generates won't
do. Eventually, when I get the DocBook markup the way I want it, I'll
figure out how to use the XML javadoc doclet and XSLT to transform what
javadoc spits out into what I want (in)directly. 

Anyway, what I'm trying to figure out how to markup a constructor in Java.
Here's what I have:

      <funcsynopsis>
      <funcprototype>
        <funcdef> <function>StatusCheck</function>
        </funcdef><void>
      </funcprototype>
      </funcsynopsis>

...unfortunately, the <void> appears to be mandatory because if I leave it
out I get a syntax error. 

The Java language doesn't allow one to indicate that a method takes no
argument by writing Foo(void). One simply writes Foo(). 

Does anyone have any suggestions for how to approach marking up a Java
class' constructor? Thanks in advance. 

Bill

From mboxrd@z Thu Jan  1 00:00:00 1970
From: Bill Brooks <wbrooks@lug.ee.calpoly.edu>
To: docbook-tools-discuss@sourceware.cygnus.com
Subject: marking up Java constructors in docbook
Date: Tue, 18 Jul 2000 14:49:00 -0000
Message-ID: <Pine.LNX.4.10.10007171529300.12345-100000@lug.calpoly.edu>
X-SW-Source: 2000-q3/msg00081.html
Message-ID: <20000718144900.Zy0hvOo-o7Am6ce5aQQLNKmn4kdDjd6hYFFnotPoc5E@z>

Hi,

How are people doing API-level documentation in DocBook? 

My immediate need is to produce some documentation of a Java class, in the
same way that JavaDoc does, but I need it to play nice inside an overall
DocBook manual, so just inserting the HTML that javadoc generates won't
do. Eventually, when I get the DocBook markup the way I want it, I'll
figure out how to use the XML javadoc doclet and XSLT to transform what
javadoc spits out into what I want (in)directly. 

Anyway, what I'm trying to figure out how to markup a constructor in Java.
Here's what I have:

      <funcsynopsis>
      <funcprototype>
        <funcdef> <function>StatusCheck</function>
        </funcdef><void>
      </funcprototype>
      </funcsynopsis>

...unfortunately, the <void> appears to be mandatory because if I leave it
out I get a syntax error. 

The Java language doesn't allow one to indicate that a method takes no
argument by writing Foo(void). One simply writes Foo(). 

Does anyone have any suggestions for how to approach marking up a Java
class' constructor? Thanks in advance. 

Bill