doxygen-develop

[Doxygen-develop] suggestion: latex formula tags (f$,f[,f{) should imply verbatim

[Ethan Tira-T. <ej...@an...>]

It's really annoying when you try to do stuff like this:
/*!
  @brief Delta torque due to delta joint position.
  This function computes \f$S_2(q, \dot{q}, \ddot{q})\delta q\f$.
*/

but that "\dot" in the formula causes doxygen to complain:
Warning: reached end of file while inside a dot block!
...and then the documentation gets hosed.

I don't know how best to fix this -- if I try to manually stick 
\verbatim in the fomula:
/*!  \f$\verbatim S_2(q, \dot{q}, \ddot{q})\delta q\endverbatim\f$  */
then somehow latex gets ahold of the verbatim tag and has throws its own 
error.  So perhaps the formula is already verbatim, and just the \dot 
command is getting through somehow?

Anyway, a work around would be nice if I'm missing something.

Thanks
 -ethan

PS I just updated my patch for bug 162968 to work with 1.4.4:
  http://bugzilla.gnome.org/show_bug.cgi?id=162968
If there's any feedback on that, I'm the one to talk to, though probably 
should do it through the bugzilla page.

RE: [Doxygen-develop] suggestion: latex formula tags (f$,f[,f{) should imply verbatim

[Michael M. <Mic...@tt...>]

Hi there,

This is listed as a bug in Bugzilla too:
http://bugzilla.gnome.org/show_bug.cgi?id=304339 

I wondered if a possible workaround would be to use the LaTeX \newcommand
option to alias \dot to something that Doxygen won't pick on.  The
\newcommand directive can be placed in some file that is then referenced
from the Doxygen input file using the EXTRA_PACKAGES, or it may be enough to
put it in a \latexonly ... \endlatexonly block. 

Alternatively from Bugzilla, it looks as though Dimitri is planning to fix
it by the next CVS update.

Regards,

Mike

> -----Original Message-----
> From: dox...@li... [mailto:doxygen-develop-
> ad...@li...] On Behalf Of Ethan Tira-Thompson
> Sent: 06 August 2005 22:32
> To: dox...@li...
> Subject: [Doxygen-develop] suggestion: latex formula tags (f$,f[,f{)
> should imply verbatim
> 
> It's really annoying when you try to do stuff like this:
> /*!
>   @brief Delta torque due to delta joint position.
>   This function computes \f$S_2(q, \dot{q}, \ddot{q})\delta q\f$.
> */
> 
> but that "\dot" in the formula causes doxygen to complain:
> Warning: reached end of file while inside a dot block!
> ...and then the documentation gets hosed.
> 
> I don't know how best to fix this -- if I try to manually stick
> \verbatim in the fomula:
> /*!  \f$\verbatim S_2(q, \dot{q}, \ddot{q})\delta q\endverbatim\f$  */
> then somehow latex gets ahold of the verbatim tag and has throws its own
> error.  So perhaps the formula is already verbatim, and just the \dot
> command is getting through somehow?
> 
> Anyway, a work around would be nice if I'm missing something.
> 
> Thanks
>  -ethan
> 
> PS I just updated my patch for bug 162968 to work with 1.4.4:
>   http://bugzilla.gnome.org/show_bug.cgi?id=162968
> If there's any feedback on that, I'm the one to talk to, though probably
> should do it through the bugzilla page.
> 
> 
> -------------------------------------------------------
> SF.Net email is Sponsored by the Better Software Conference & EXPO
> September 19-22, 2005 * San Francisco, CA * Development Lifecycle
> Practices
> Agile & Plan-Driven Development * Managing Projects & Teams * Testing & QA
> Security * Process Improvement & Measurement * http://www.sqe.com/bsce5sf
> _______________________________________________
> Doxygen-develop mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-develop