← Back to team overview

fenics team mailing list archive

Re: Generation of docstring module

 

[snip]

> Are you saying we need stuff like
> 
>   <detaileddescription><para><verbatim>
> 
> in the header files?

No just:

  /// \verbatim
  /// Some comment...
  /// \endverbatim

> That doesn't look very nice. In that case I would cast a clear vote
> for not using Doxygen. It's a mess if we have to mix reST and some
> other markup language. The beauty of reST is that it looks good and
> non-intrusive.
> 
> Btw, we are already using a mix since generate_cpp_doc.py adds the
> extra functionality for _Mesh_ which links "Mesh" to the documentation
> page for that class.

Ok.

Johan



References