15 Mar
2004
15 Mar
'04
1:59 p.m.
>> "Niels" == Niels Van Vliet
<niels(a)lrde.epita.fr> writes:
@@ -38,6 +38,9 @@
# include <functional>
namespace oln {
+ /*!
+ ** \brief Namespace for arithmetic.
+ */
namespace arith {
oln_arith_declare_binrecval_functors_(plus,
Souvent les documentations (et publications d'ailleurs) sont plus
agréables à lire quand on supprime les mots inutiles. Ici par
exemple, le `Namespace for' est totalement inutile. Plus utile serait
de savoir ce qu'est l'arithmétique ici. Par exemple (wild guess):
\brief Arithmetic operators on recursive values.
(Genre).
Tjs dans le genre inutile, voir
http://www.lrde.epita.fr/~akim/compil/tc-doc/index.html
où on a des choses du genre :
arrayexp.cc Implementation for ast/arrayexp.hh
arrayexp.hh
arrayexp.hxx Inline methods for ast/arrayexp.hh
C'est complètement con, on se doute de la correspondance entre les
fichiers. Ce qui est plus intelligent c'est de pointer sur la classe,
là on a un intérêt hyper-texte :
arrayexp.cc Implementation of ast::ArrayExp
arrayexp.hh Declaration of ast::Arrayexp
arrayexp.hxx Inline methods of ast::ArrayExp
Mieux encore, sans mots inutiles :
arrayexp.cc ast::ArrayExp implementation
arrayexp.hh ast::Arrayexp declaration
arrayexp.hxx Inline methods of ast::ArrayExp