Laurent comment on fait les doc ;D ?

[kamui]

Bonjour à tous !

Bon c'est vrai je m'adresse surtout à Laurent, mais vous pouvez répondre aussi vous vous y connaissez surement.

En fait j'ai généré une doc pour une librairie que je suis en train de faire, et ça s'organise pas vraiment comme je voudrais. Donc j'aimerais avoir le maximum d'infos sur comment tu as généré la doc de sfml : doxygen ou autre ? Par exemple, comment as-tu fait pour avoir une section modules plutôt qu'un section namespaces ? Inclure du code dans la main page ? Quel degré de transparence as-tu choisi pour la documentation vis-à vis de ton code ? etc..

Merci d'avance si tu as l'amabilité de me parler de ta recette, sinon, bah merci quand même en fait ^^

++

[Laurent]

Salut

J'utilise en effet doxygen (c'est comme le Port Salut, c'est marqué dessus ).

comment as-tu fait pour avoir une section modules plutôt qu'un section namespaces ?

Tout d'abord il faut définir les "groupes" :

\defgroup audio Audio module

puis dire à quel groupe chaque classe appartient

\class sf::Sound
\ingroup audio

Inclure du code dans la main page ?

J'ajoute un fichier pipeau (mainpage.hpp) dans les sources que doxygen traite, et ce fichier démarre avec une directive spéciale :

\mainpage

Pour le contenu, c'est du doxygen classique (\section, \code, ...).

Quel degré de transparence as-tu choisi pour la documentation vis-à vis de ton code ?

J'ai pas compris la question là

Mais n'hésite pas à regarder directement dans les en-têtes, et à fouiller mon fichier doxyfile, ça ira probablement plus vite que de me demander

[kamui]

ah je savais pas que tu partageais le doxyfile.

Pour l'histoire de la transparence, c'est au niveau du code (on peut faire apparaitre ou pas les données privées, les trucs non documentés etc, mais bon t'as raison je vais fouiller directement les fichiers source)

Merci @+

[Laurent]

Je ne fais apparaître ni les sources, ni les membres privés. Uniquement ce qui sert aux utilisateurs.

[kamui]

Ok merci^^

Bonne journée (à tous aussi)