Re: Access to "javadoc"?

[Don Blaheta <blahedo blahedo org>]

Quoth Lars Clausen:
> On Jul 30, 2008, at 9:05 PM, Don Blaheta wrote:
>
> > I've noticed that the code is fairly well-commented using a modified
> > javadoc format; is there a particular program you have for compiling  
> > it into browsable html (as with javadoc)?  Or is it just in this
> > careful format for code legibility reasons?  Apologies if this is
> > answered somewhere, but I didn't see it in the FAQ, on the Wiki, or
> > in the tarball (but could have missed it...)
>
> It is not currently "compiled", but I'm fairly sure there are tools to
> do so.

There are; a while back I used Doc++, and a quick googling indicates a
current contender is called "doxygen".  What I thought was interesting
was that there were some very javadoc-y comments that start with /**,
but also some with /*! or /*!< or \brief, but I wasn't sure what the
semantics were.  Is that documented anywhere, or was it just ad hoc?
I can look into it, but I hate to reinvent the wheel if someone's
already got this working.

> I started the trend of using JavaDoc style after getting used
> to it in Java - it's a bit more bothersome in C, since there's no
> autogeneration, though. Some of the docs are guesswork from what the
> code says and how it's used, since I wrote them long after somebody
> else did the code. I was aiming for covering all the "core" code (i.e.
> the lib dir), but didn't have enough vacation for that.

Eh, some documentation is better than no documentation.  And one of the
things I would most like is a class browser, even without a lot of
descriptions.  Which would (presumably) be easy for a doc-generator. :)

-- 
-=-Don Blaheta-=-=-blahedo blahedo org-=-=-=-<http://www.blahedo.org/>-=-
"People do what they want to do. Corollary: When people do things, it's
because they want to do them. This philosophy saves me a lot of time
that would otherwise be wasted on trying to figure out other people's
motives."                                       --Casey Westerman