tsp-devel
[Top][All Lists]
Advanced

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

Re: [Tsp-devel] /*! \file doxygen header


From: Erk
Subject: Re: [Tsp-devel] /*! \file doxygen header
Date: Tue, 7 Feb 2006 21:28:49 +0100

Si je peux mais ça génère what milliards de commit
"pour rien".

De plus il pourrait y avoir des fichiers avec des en-têtes
"intéressantes" pour lesquelles j'aimerais garder le  /*!  \file

Si y'en a qui traine trop je ferais le script..

Le 07/02/06, dufy<address@hidden> a écrit :
> Tu veux pas faire un script recursif pour le faire totomatiquement ?
>
>
> Le 06/02/06, Erk <address@hidden> a écrit :
> >
> > Salut à tous,
> >
> > En préparant la 0.7.1
> > j'ai voulu faire un petit passage sur la doc générée par doxygen.
> > Je me suis aperçu que tous les fichiers avaient par défaut
> > la balise:
> >
> > /*!  \file
> >
> > en début de fichier ce qui signale à doxygen que de la doc
> > concernant le fichier suit.
> > [Mal]heureusement la plupart des commentaires
> > qui suivents ne sont que de la LGPL ce qui ne constitue pas
> > "de la doc sur l'objet" du fichier.
> >
> > J'ai commencé à remplacer les
> > /*!  \file
> > par
> > /*
> >
> > ce qui a pour effet d'éviter nombre de doc "inutiles".
> >
> > Comme c'est un peu fastidieux de faire cette modif sur
> > tous les fichiers merci à chacun de faire ce changement
> > sur les fichiers (.c ou .h) qu'il commite SAUF si bien
> > sûr de la doc "utile" est contenue dans le header qui suit.
> >
> > !! ATTENTION !!
> > La balise doxygen /* \file est INDEPENDANTE
> > de la doc doxygen concernant l'API du genre
> > de :
> > /**
> > * Destroy a GLU_handle.
> > * for member function.
> > * @param glu OUT, pointer to a GLU_handle pointer that will be allocated
> > * @return TRUE if ok FALSE otherwise
> > */
> > int32_t GLU_handle_destroy(GLU_handle_t** glu);
> >
> > Merci d'avance de vos contribs.
> > --
> > Erk
> >
> >
> > _______________________________________________
> > Tsp-devel mailing list
> > address@hidden
> > http://lists.nongnu.org/mailman/listinfo/tsp-devel
> >
>
>


--
Erk




reply via email to

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