Subject: Re: doxygen output on abisource.org
From: Jesper Skov (jskov@redhat.com)
Date: Mon Jan 22 2001 - 02:01:55 CST
>>>>> "Sam" == Sam TH <sam@uchicago.edu> writes:
Sam> On Sun, Jan 21, 2001 at 10:17:02AM +0100, Jesper Skov wrote:
>> >>>>> "Sam" == Sam TH <sam@uchicago.edu> writes:
Sam> Everyone should check out http://www.abisource.com/doxygen
>>
Sam> Hourly generation and a link on the main page should be coming
Sam> soon, after other people tell me it works.
>> Works a charm. Thanks!
>>
Sam> If a person wanted to edit the main doxygen page, where would the
Sam> source for that be? Is there anything special to know about
Sam> changing the doxygen stuff that's not auto-generated from
Sam> comments?
The main page is the src/README.TXT file. There's not much magic to
it. Most HTML tags are understood, and I suggest we use those as much
as possible over doxygen syntax since most people already grok HTML.
Code comments are doxygenified simply by changing them from:
/*
...
*/
//
To:
/*!
...
*/
///
There are some limitations on where a function description can/should
be put. But I suggest people look at
http://www.abisource.com/doxygen/class_fp_Container.html and the
fp_Container.cpp/h files for examples.
I (or someone else) should add some doxygen primer and guidinglines
for use in AbiWord to the main page so the information is readily
available. The barrier to adding documentation should be essentially
zero - everybody with an understanding of C/C++ should be able to
help.
Jesper
This archive was generated by hypermail 2b25 : Mon Jan 22 2001 - 02:02:10 CST