Re: [Consmgr-tech] doxygen doc formatting
Status: Alpha
Brought to you by:
cross
|
From: Chris R. <cro...@di...> - 2008-04-02 23:30:55
|
On Apr 2, 2008, at 5:38 PM, Geoff Adams wrote:
> I'm surprised that's not a default. After using JavaDoc for years, I
> generally try to make the first sentence of such comments be a simple
> summary suitable for such purposes. What you described is exactly what
> JavaDoc does. And, in fact, the JavaDoc format specifies that there
> should (must, in fact, I think) be a first sentence, including a
> period, so that it can use that for the brief description.
There's a JAVADOC_AUTOBRIEF too, which uses the javadoc style
comments, as you mention.
I think that's the /** ... */ things. I'm not sure. I didn't know
anything about javadoc, and the QT thing seemed closer to what I was
inclined to do for docs. Clearly, since you're familiar with
javadoc, I should look at that format too. doxygen totally likes
it, AFAIK.
- Chris
|