[osg-submissions] osg documentation
Jean-Christophe Lombardo
lombardhome at gmail.com
Wed Jan 23 05:38:12 PST 2008
Oups, sorry. I did not noticed your answer before.
1) searching: it requires that your web server as php 4.1.0 or above
enabled. Mainly, it means that the search engine won't work if you
test it through the file::// protocol.
2) tag files. They keep in a way that doxygen understand a link
between the code and the documentation. It is useful to establish
links between documentations.
Typically we have setup a local server which hold doxygen extracted
documentation for the various API we are using. Every night, we
regenerate our own application documentation with something like this
cd $PROJECTROOT
svn update
cd doc
wget -N http://my.local.doc.server/osg/osg.tag
doxygen
In the Doxyfile the link between tags and URL is defined by:
TAGFILES = osg.tag=http://my.local.doc.server/osg/
This defines html links for osg entities used in our application.
If you generate a tag file with osg official documentation, I (and
every osg user) could establish link directly with
http://www.openscenegraph.org/documentation/OpenSceneGraphReferenceDocs/
instead of keeping a local copy.
jcl
PS: I'm not sure that I made myself clear... Today seems to be a hard
day for English speaking...
More information about the osg-submissions
mailing list