This is the mail archive of the
systemtap@sourceware.org
mailing list for the systemtap project.
Re: inline documentation syntax
- From: Masami Hiramatsu <mhiramat at redhat dot com>
- To: "Frank Ch. Eigler" <fche at redhat dot com>
- Cc: systemtap at sources dot redhat dot com
- Date: Tue, 05 Feb 2008 12:30:16 -0500
- Subject: Re: inline documentation syntax
- References: <20080205164918.GB8423@redhat.com>
Hi Frank,
Frank Ch. Eigler wrote:
> Hi -
>
> A followup on my note regarding bug #5679. Other than nits regarding
> my suggested operator "@@" (hey, pronounce it "look-here"!), the other
> possibility would be to support javadoc. The difficulty with this is
> that IMO it's important for the translator do directly parse this
> stuff, and not just leave it to a separate documentation generator
> tool.
IMHO, javadoc format or other formats supported by other tools have
some advantages. If we support those standard formats, we can easily
get new developers who are used to those documentation formats. And
some IDEs/Editors already support those formats.
We might better take account of it.
Thank you,
--
Masami Hiramatsu
Software Engineer
Hitachi Computer Products (America) Inc.
Software Solutions Division
e-mail: mhiramat@redhat.com