Re: [Simulavr-devel] Re: Some questions and my offer to help you

[reinhard . jessich]

On Wed, 02 Jan 2002, ken restivo wrote:
>  ...much good stuff has been snipped here ...
Yes, but I hate to read every time the same. I have seen on the mingw list that
snipping is done often.

<snip>

> i love this. i discovered doxygen when surfing through nutos and was very
> impressed by it. i mentioned this to ted, and sent him some sample output, but
> he didn't get quite as much of a woody about it as i did. ;-)
> i would volunteer to do this... to go through every function and write
> doxygen comments for them. in most cases, it's simply a matter of reformatting
> ted's existing comments with doxygen tags. the exercise would really help me
> understand simulavr too.
But this must be done in the header files. So the comments must be moved. I do
the comments in the C file only for private functions.
 I need to install doxygen
on my machine. I use it only in the company. It will take some while

> but i am very new to doxygen. if reinhard can perhaps start on one file, and
> establish a standard, i can follow his example and do a bunch myself. if we
> split the work it may go faster.
I use it only in the company. I need to install doxygen on my machine.
This can take a while (I work on other things also).

> i can't speak from experience, but i have a hunch that this type of
> fastidious documentation would help in the long run. i believe it will make
> the code more accessible, making it faster and easier for other people to find
> and fix bugs, add functionality, or otherwise contribute to the project.
I agree with you.

If I have installed doxygen, I will provide an example of a file. If Ted says
that it is ok to start.

Reinhard

-- 
 Ing. Reinhard Jessich              mailto: address@hidden
 A-1190 Vienna, Goergengasse 2/2/1  phone: +43/1/3692600
 http://members.telering.at/jessich mobile: +43/664/1735439