Re: [Tsp-devel] MAJ doc doxygen

[Erk]

Euskadi,

(je te mets le mail en direct+tsp-devel
 car savannah rencontre quelques soucis avec leur serveur de list
https://savannah.gnu.org/forum/forum.php?forum_id=4322 )


J'ai fait une première passe pour te mettre un exemple
de doc doxygen dans gdisp+

L'idée est qu'on crée un groupe (\defgroup) de doc
par groupe logique de code.
En C++ les defgroup sont "implicites" == 1 pour chaque classe
en C c'est à toi de grouper les élements documentés
(function, struct, enum etc...) dans un groupe.

Pour les applis je suggères:

1) 1 groupe pour l'appli que l'on mets dans
    le fichier qui contient le main:
   /**
    * @defgroup TSP_GDispPlus GDisp+
    * @ingroup  TSP_Consumers
    * tsp_gdisp+ is the second generation TSP consumer GUI.
    [....]
    */
    voir la suite dans src/consumer/gdisp+/gdisp_main.c

2) des sous-groupes pour les libs (de l'appli)
         - gdisp_kernel
         - gdisp_xml etc...
    Chaque sous-groupe est à definir dans le .h qui le concerne:
    par exemple dans gdisp_kernel.h
en debut de .h

/**
 * @defgroup TSP_GDispPlus_Kernel Kernel API
 * @ingroup TSP_GDispPlusLib
 * @{
 */

.... definition des functions; struct, #define etc...
    avec documentation doxygen

fermeture du groupe de doc en fin de fichier.

/** @} */

On peut faire plein d'autre choses avec doxygen
(icnlure des images, indiquer des liens interne/externe etc...)
je prépare aussi de la doc :)) pour dire comment on fait
pour faire de la doc :))



2006/2/28, Euskadi <address@hidden>:
>
> Personnellement, j'ai utilisé doxy il y a très longtemps.
> Je ne sais plus trop ce qu'est un \defgroup.
> Sorry.
>
> Si quelqu'un y arrive avant moi, je regarderai...
>
>
> Euskadi.
>
>
>
>
> On Sun, 26 Feb 2006 16:57:52 +0100, Erk <address@hidden> wrote:
>
> > Salut les amis,
> >
> > J'ai fait une mise à jour conséquente de la documentation de l'API
> > TSP ce qui a pour effet de modifier un grand nombre de fichiers
> > .c/.h et ajout suppression de *.dox.
> >
> > J'ai ré-organisé les modules de doc qui sont désormais  décrits dans:
> > tsp/src/doxy/tsp_doc_tree.dox
> >
> > vous pouvez regnérer la doc avec
> > cd tsp/src/doxy ; make
> > il vous faudra une version de doxygen pas trop vieille
> > et l'outil 'dot ' du package graphviz pour avoir les quelques
> > diagrammes de collaboration.
> >
> > Vous pouvez aussi jeter un oeil directement là:
> > http://www.ts2p.org/tsp/API_doc/html/
> >
> > Je trouve que ça commence à avoir une tête raisonnable mais
> > je suis preneur de toute remarque constructive à ce sujet.
> >
> > J'aimerais que chacun maintienne la doc d'API de sa partie
> > si celà est pertinent,
> > je décrirais comment faire très prochainement, mais en essence:
> >
> > 1) un \defgroup par application finale (gdisp+, bb_tsp_provider,
> > tsp_ascii_writer, bb_tools...)
> >      un éventuel \defgroup de plus si l'appli exporte une librairie
> >       cf AsciiWriter
> >
> > 2) RTFM de doxygen pour le reste et suivre les exemples en place.
> >
> > Je vous conseille un bon cvs update.
> >
> > --
> > Erk
> >
> >
> > _______________________________________________
> > Tsp-devel mailing list
> > address@hidden
> > http://lists.nongnu.org/mailman/listinfo/tsp-devel
>
>
>


--
Erk