From: "Scott Goodwin" <scottsgoodwin@home.com>
To: "Bill Brooks" <wbrooks@lug.ee.calpoly.edu>,
<docbook-tools-discuss@sourceware.cygnus.com>
Subject: RE: marking up Java constructors in docbook
Date: Wed, 27 Dec 2000 06:36:00 -0000 [thread overview]
Message-ID: <000101bff106$c3ef4940$0201a8c0@fountainhead.internal.com> (raw)
In-Reply-To: <Pine.LNX.4.10.10007171529300.12345-100000@lug.calpoly.edu>
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
WARNING: multiple messages have this Message-ID
From: "Scott Goodwin" <scottsgoodwin@home.com>
To: "Bill Brooks" <wbrooks@lug.ee.calpoly.edu>,
<docbook-tools-discuss@sourceware.cygnus.com>
Subject: RE: marking up Java constructors in docbook
Date: Tue, 18 Jul 2000 15:23:00 -0000 [thread overview]
Message-ID: <000101bff106$c3ef4940$0201a8c0@fountainhead.internal.com> (raw)
Message-ID: <20000718152300.sYX_qE-kYEqRPlBFmqp2PsKpyeqYe0TCIQgS3l4QMx4@z> (raw)
In-Reply-To: <Pine.LNX.4.10.10007171529300.12345-100000@lug.calpoly.edu>
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
next prev parent reply other threads:[~2000-12-27 6:36 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2000-12-27 6:36 Bill Brooks
2000-07-18 14:49 ` Bill Brooks
2000-12-27 6:36 ` Scott Goodwin [this message]
2000-07-18 15:23 ` Scott Goodwin
2000-12-27 6:36 ` Norman Walsh
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to='000101bff106$c3ef4940$0201a8c0@fountainhead.internal.com' \
--to=scottsgoodwin@home.com \
--cc=docbook-tools-discuss@sourceware.cygnus.com \
--cc=wbrooks@lug.ee.calpoly.edu \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).