Hi Erik,
I have just complete a merge of most of your changes. One I didn't
merge was the the directory name change from OpenSceneGraphDocs to
HtmlReference, as OpenSceneGraphDocs is something has been used for a
long time, and is referenced by the website, and frankly HtmlReference
doesn't mean any specific to the OSG so offers nothing other than
breaking html links.
The other problem that I'd like to resolve before merging is that you
specifically reference FreeSans.ttf, while this works on my Kubuntu
box I'm concerned about how well it'll travel, ie. to Internet
Explorer, or on the Mac, or on IRIX, Solaris, HP-UX etc. Could you
explain your reason for this change, and also the steps you've
undertaken to ensure that this font is widely available.
Thanks,
Robert.
On Sun, Aug 17, 2008 at 12:37 AM, Erik den Dekker <[EMAIL PROTECTED]> wrote:
> Hi all,
>
>
>
>
>
> Using the latest OSG SVN version and the latest stable release of doxygen, I
> ran into some problems while generating documentation. I made several
> modifications:
>
>
>
> The cause of my errors was that my OSG source directory path contains
> spaces. To fix this issue I wrapped all paths with quotes, as stated in
> doxygen documentation.
>
>
>
> I also received some warning messages about deprecated doxygen settings,
> which I fixed by updating the doxygen file, i.e. running 'doxygen –u
> doxygen.cmake'. By running this command deprecated doxygen options are
> removed, some option comments have changed and quite some options have been
> added (I kept their default settings unless mentioned).
>
>
>
> I was surprised to find that the doxygen OUTPUT_DIRECTORY was set to
> "${OpenSceneGraph_SOURCE_DIR}/doc", which does not seem appropriate for out
> of source builds; I changed this to "${OpenSceneGraph_BINARY_DIR}/doc". (On
> the other hand, maybe a cmake selectable option should be given to the
> user?)
>
>
>
> Changed option HTML_OUTPUT from 'OpenSceneGraphReferenceDocs', which seemed
> a bloated directory name to me, to 'HtmlReference'.
>
>
>
> Fixed two warnings I received about unexpected end-of-list-markers in
> 'osg\AnimationPath' and 'osgUtil\CullVisitor' due to excess trailing points
> in comments.
>
>
>
> Fixed a warning in 'osgWidget\StyleInterface' due to an #include directive
> (strangely) placed inside a namespace.
>
>
>
> Fixed a warning in 'osg\Camera' due to the META_Object macro that confused
> doxygen. Adding a semi-colon fixed this.
>
>
>
> Removed auto_Mainpage from the INCLUDE option, because I am positive that
> this file does not belong there; It never generated useful documentation
> anyway.
>
>
>
> I added the OSG version number environment variable to the PROJECT_NUMBER
> option so that the version number is now shown on the main page of generated
> documentation (e.g. index.html).
>
>
>
> Changed option FULL_PATH_NAMES to YES, but made sure STRIP_FROM_PATH
> stripped the absolute path until the include dir. This fixed an issue that
> created mangled names for identical filenames in different directories. E.g.
> osg/Export and osgDB/Export are now correctly named.
>
>
>
> Changed option SHOW_DIRECTORIES to yes, which is a case of preference I
> guess.
>
>
>
> These changes fix all errors and warnings during doxygen documentation
> generation on my computer. Tested under Windows XP SP3, Visual Studio 2008,
> CMake 2.6, Doxygen 1.5.6, GraphViz 2.20
>
>
>
>
>
> There are still three doxygen issues remaining that bug me:
>
>
>
> The CMakeLists.txt has
>
>
>
> Should documentation be installed when building the install target?
>
>
>
> What exactly is the purpose/difference of the cmake options
> 'BUILD_DOCUMENTATION' and 'BUILD_REF_DOCS'? Can these be merged?
>
>
>
>
>
> Cheers,
>
>
>
> Erik den Dekker
>
>
>
> _______________________________________________
> osg-submissions mailing list
> [email protected]
> http://lists.openscenegraph.org/listinfo.cgi/osg-submissions-openscenegraph.org
>
>
_______________________________________________
osg-submissions mailing list
[email protected]
http://lists.openscenegraph.org/listinfo.cgi/osg-submissions-openscenegraph.org
