[osg-users] reference docs generation questions
Hi all, I'm about to post a little improvement on the refdoc generation. It includes an update of the doc/doxyfile.cmake template and an install target for the generated documentation. The latter will enable packaging openscenegraph-doc. I have some questions though: 1 I have updated and worked with doxyfile.cmake. In the doc folder are also all_Doxyfile, auto_Doxyfile, auto_Mainpage, core_Doxyfile but they seem to be outdated to different degrees. Now I can update these and add separate targets for them but only if we want them. Otherwise they should be removed. Thoughts? 2 The current generated refdocs doesn't include OpenThreads. Should there be a separate documentation for openthreads or should it be made part of OpenScenGraphReferenceDocs? cheers Mattias ___ osg-users mailing list osg-users@lists.openscenegraph.org http://lists.openscenegraph.org/listinfo.cgi/osg-users-openscenegraph.org
Re: [osg-users] reference docs generation questions
Hi all On 12/15/08, Robert Osfield robert.osfi...@gmail.com wrote: Hi Mattias, On Mon, Dec 15, 2008 at 1:35 PM, Mattias Helsing helsin...@gmail.com wrote: I'm about to post a little improvement on the refdoc generation. It includes an update of the doc/doxyfile.cmake template and an install target for the generated documentation. The latter will enable packaging openscenegraph-doc. I have some questions though: I was thinking along the same lines - that an openscenegraph-doc would be appropriate. That FIXME in the toplevel CMakeLists.txt have been aching in my eyes for some time now ;-) 1 I have updated and worked with doxyfile.cmake. In the doc folder are also all_Doxyfile, auto_Doxyfile, auto_Mainpage, core_Doxyfile but they seem to be outdated to different degrees. Now I can update these and add separate targets for them but only if we want them. Otherwise they should be removed. Thoughts? I'd say update them all, but then just have one doc target. will do 2 The current generated refdocs doesn't include OpenThreads. Should there be a separate documentation for openthreads or should it be made part of OpenScenGraphReferenceDocs? Technically we have an libopenthreads package so a openthreads-doc package would be appropriate. One could roll the openthreads docs into openscenegraph-doc, but then it breaks the consistent lines that we trying to draw in the packaging. I think we also have to bare in mind what other package maintainers such as for Debian or Redhat would require, and in this case I'd guess that they would go for an separate openthreads-doc. you are right. Mattias Robert. ___ osg-users mailing list osg-users@lists.openscenegraph.org http://lists.openscenegraph.org/listinfo.cgi/osg-users-openscenegraph.org ___ osg-users mailing list osg-users@lists.openscenegraph.org http://lists.openscenegraph.org/listinfo.cgi/osg-users-openscenegraph.org
Re: [osg-users] reference docs generation questions
Hi Mattias, On Mon, Dec 15, 2008 at 1:35 PM, Mattias Helsing helsin...@gmail.com wrote: I'm about to post a little improvement on the refdoc generation. It includes an update of the doc/doxyfile.cmake template and an install target for the generated documentation. The latter will enable packaging openscenegraph-doc. I have some questions though: I was thinking along the same lines - that an openscenegraph-doc would be appropriate. 1 I have updated and worked with doxyfile.cmake. In the doc folder are also all_Doxyfile, auto_Doxyfile, auto_Mainpage, core_Doxyfile but they seem to be outdated to different degrees. Now I can update these and add separate targets for them but only if we want them. Otherwise they should be removed. Thoughts? I'd say update them all, but then just have one doc target. 2 The current generated refdocs doesn't include OpenThreads. Should there be a separate documentation for openthreads or should it be made part of OpenScenGraphReferenceDocs? Technically we have an libopenthreads package so a openthreads-doc package would be appropriate. One could roll the openthreads docs into openscenegraph-doc, but then it breaks the consistent lines that we trying to draw in the packaging. I think we also have to bare in mind what other package maintainers such as for Debian or Redhat would require, and in this case I'd guess that they would go for an separate openthreads-doc. Robert. ___ osg-users mailing list osg-users@lists.openscenegraph.org http://lists.openscenegraph.org/listinfo.cgi/osg-users-openscenegraph.org
Re: [osg-users] reference docs generation questions
Hi Mattias, 2 The current generated refdocs doesn't include OpenThreads. Should there be a separate documentation for openthreads or should it be made part of OpenScenGraphReferenceDocs? I vote for part of OpenScenGraphReferenceDocs. Reason: OpenThreads is distributed with OpenScenGraph, so why not its doc? Sukender PVLE - Lightweight cross-platform game engine - http://pvle.sourceforge.net/ ___ osg-users mailing list osg-users@lists.openscenegraph.org http://lists.openscenegraph.org/listinfo.cgi/osg-users-openscenegraph.org
