[chbot] Lazy software developers please read...

[Ivo Gorny]

Hi Charles,

I have a little experience with doxygen under Windows. Actually I'm 
using Atmel Studio 6.2 with the Visual Micro extension to write C and 
C++ code for Arduinos. I installed doxygen but have actually not 
included any doxygen tags in my source code. However, doxygen already 
generates an output like this (beautiful in HTML, which I stripped down 
for this mailing list to plain text):

     clsUpTime Class Reference

     List of all members.

     Public Member Functions

     unsigned long totalSeconds ()
     unsigned long totalMicros ()
     unsigned long duration ()
     unsigned long shortest ()
     unsigned long longest ()
     boolean calculated ()
     unsigned long downTime ()
     void addDownTime (unsigned int downTime)
     void startTimeTaking ()
     boolean calcTime ()
     void resetAll ()
     int getElapsedTime (char *buffer, size_t size)

--------------------------------------------------------------------------------
     The documentation for this class was generated from the following 
files:
     C:/SD-CARD/ARDUINO/Sketchbook/Blinky/clsUpTime.h
     C:/SD-CARD/ARDUINO/Sketchbook/Blinky/clsUpTime.cpp

Looks like you can just start with doxygen without a specific tool to 
create a list of functions because doxygen traverses through the files 
on its own.
Have you tried doxygen already and how does the output look like?

Ivo


On 6/08/2014 1:48 p.m., Charles Manning wrote:
> I'm hoping there is a lazy (or efficient, if you prefer) software
> developer that can steer me in the right direction.
>
> I have approx 15000 lines of code that I need to add some more
> comments to. I am thinking of using doxygen for all the functions
> /structures.
>
> Does anyone know of a tool that can add doxygen headers to C functions/structs?
>
> I'm clearly not expecting the tool to figure out what the functions
> do, but it should be possible for such a tool to generate all the
> boring boilerplate stuff.
>
> First prize would be that it works under Linux.
>
> Thanks
>
> Charles
>
> _______________________________________________
> Chchrobotics mailing list Chchrobotics at lists.linuxnut.co.nz
> http://lists.ourshack.com/mailman/listinfo/chchrobotics
> Mail Archives: http://lists.ourshack.com/pipermail/chchrobotics/
> Web site: http://kiwibots.org
> Meetings 3rd Monday each month.
>
> When replying, please edit your Subject line to reflect new content.
>