[NeXus-tech] Doxygen output

[Peterson, Peter F.]

Freddie,

I think that people are more likely to look at the python documentation via the built-in help documentation than the web-page. For that reason I'm in favor of your suggestion of having the example using doxygen syntax and the rest in pydoc.

P^2


On Feb 16, 2010, at 2:42 PM, <freddie.akeroyd at stfc.ac.uk<mailto:freddie.akeroyd at stfc.ac.uk>> <freddie.akeroyd at stfc.ac.uk<mailto:freddie.akeroyd at stfc.ac.uk>> wrote:

I’ve split the Doxygen generated output into separate bindings at http://download.nexusformat.org/ Doxygen will parse python source for standard “documentation strings” , but it is not possible to use doxygen special formatting commands in this scheme. If we want to use such Doxygen constructs in python we would need to document the files in a slightly different way as detailed at  http://www.doxygen.nl/docblocks.html#pythonblocks, but I think there is merit in having python documentation in its own standard way. Maybe we just add a few extras like examples via doxygen syntax and leave the rest in pydoc format?

Regards,

Freddie



--
Scanned by iCritical.

<ATT00001..txt>