[vtk-developers] Wanted: Some advice re documentation of vtkParametric Functions.

[Mathieu Malaterre]

Brad King wrote:
> Andrew Maclean wrote:
> 
>> I am looking for some advice regarding the documentation of the
>> vtkParametric functions. At present I have got the relevant equations and
>> derivatives as part of the documentation for the Evaluate() function.
>>
>> However a quick check of the documentation will reveal that this is a 
>> mess.
>> I suspect that some of the doxygen formatting hints are being stripped 
>> out.
>>
>> So, has anyone any ideas?
>> My preferred option is to keep this detail with the Evaluate() function.
>> However if this is not feasible, I could create a plain text file (or 
>> html
>> page) that could be referenced somehow or a PDF.
>>
>>  
>> Perhaps someone at Kitware may be able to offer some advice.
> 
> 
> I don't think the VTK documentation generator supports equations.  It 
> may be related to the script that converts "// Description:" comments to 
> doxygen-style.

Apparently there is a way to generate it properly:

http://vtk.org/Bug/bug.php?op=show&bugid=1456&pos=15



Date: 4:51 PM On 01-04-2005
I have documented vtkMeshQuality.h using LaTeX formulas, enclosed within 
f$ ... f$.
This works fine when I'm compiling on my platform, the images are 
correctly generated and linked.

However, is here the nightly build:
http://www.vtk.org/doc/nightly/html/classvtkMeshQuality.html
and it turns out that the LaTeX expressions are not properly compiled, 
and appear almost in extenso: only the f's have been removed; e.g.:
f$frac{R}{2r}f$
appears as
$frac{R}{2r}$


Maybe we have wrong version of doxygem/dot/gnuplot ?

Mathieu