Re: [CPROG] Dokumentering af API

[Robert Larsen <sslug@sslug>]

Henrik Brix Andersen wrote:

> Hej,
>
> Jeg er i gang med at udvikle et library i ANSI C, og skal naturligvis
> have genereret noget dokumentation over API'et. I den forbindelse har
> jeg kigget lidt på gtk-doc, som på trods af navnet ikke afhænger af
> gtk+...
>
> Jeg ville høre, om der er nogen af jer, der har erfaring med enten
> gtk-doc eller lignende utilities til dokumentering af C-kode.
>
> Jeg vil gerne kunne skrive det meste af dokumentationen som kommentarer
> i kildeteksten, og så lade den pågældende utility selv extracte
> informationerne og generere (bl.a.) en html-udgave af dokumenterne...
>
> Mvh
> ./Brix
>
> PS:Jeg bruger autotools (automake, autoconf osv.) til projektet, så det
> vil ikke skade hvis den pågældende utility er understøttet med
> m4macroer.
>  
Jeg tror, at du burde tage et kig på Doxygen 
(http://www.stack.nl/~dimitri/doxygen/). Du skriver dokumentationen som 
specielt formatterede kommentarer i koden, og så køres Doxygen 
compileren gennem al koden og dokumentationen bliver genereret som HTML, 
LaTeX, RTF eller manual sider. XML er vist også et muligt output.


VH
Robert

--
"This is a Unix system...I know this." - Little girl from Jurassic Park