tsp-devel
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: [Tsp-devel] MAJ doc doxygen


From: Euskadi
Subject: Re: [Tsp-devel] MAJ doc doxygen
Date: Tue, 28 Feb 2006 14:39:25 +0100
User-agent: Opera M2/7.54 (Win32, build 3865)


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






reply via email to

[Prev in Thread] Current Thread [Next in Thread]