This is the mail archive of the
docbook-tools-discuss@sources.redhat.com
mailing list for the docbook-tools project.
RE: marking up Java constructors in docbook
- To: "Bill Brooks" <wbrooks at lug dot ee dot calpoly dot edu>,<docbook-tools-discuss at sourceware dot cygnus dot com>
- Subject: RE: marking up Java constructors in docbook
- From: "Scott Goodwin" <scottsgoodwin at home dot com>
- Date: Tue, 18 Jul 2000 17:23:14 -0500
Hmmm...although I haven't looked closely at DocBook 4, I did read something
about it supporting newer object-oriented languages - yep, here it is in the
release notes:
- Added synopsis markup for modern programming languages (e.g, object
oriented languages like Java, C++, and IDL)
And here's the url: http://www.oasis-open.org/docbook/sgml/4.1/40chg.txt
s.
-----Original Message-----
From: Bill Brooks [mailto:wbrooks@lug.ee.calpoly.edu]
Sent: Tuesday, July 18, 2000 4:49 PM
To: docbook-tools-discuss@sourceware.cygnus.com
Subject: marking up Java constructors in docbook
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