It looks like there are some recent changes to the doc structure that I
haven't merged yet. So this patch may not work.
On Thu, Jan 20, 2011 at 6:05 PM, David Kabala <[email protected]> wrote:
> I would like to submit a patch that adds support for separate doxygen
> documentation for each OpenSG library similar to the discussion
> here<http://www.opensg.org/wiki/Dev/Documentation>
> .
>
> I added support for building separate doxygen documentation for each
> OpenSG library. The separate documentation trees reference the
> documentation of dependent libraries. New build targets are made for
> building the documentation of a library, e.g. to make the OSGDrawable
> library documentation use: make OSGDrawableDoc. This will build the
> dependent library docs first.
>
> The new cmake option OSG_GENERATE_SEPARATE_LIB_DOC can be used to turn the
> building of separate doxygen documentation on or off. By default it is off.
>
> I also added cmake configuration for installing doxygen documentation. If
> the new cmake option OSG_INSTALL_DOXYDOC is on then the doxygen
> documentation will be installed to
> <INSTALL_PREFIX>/share/OpenSG/documentation. By default OSG_INSTALL_DOXYDOC
> is off.
>
> The following is a link to an example build of the documentation. Note,
> this is a doc build from a fork of the OpenSG 2 repository with some of my
> own additions to the core OpenSG source.
> http://www.vrac.iastate.edu/~dkabala/OpenSGDocExample<http://www.vrac.iastate.edu/%7Edkabala/OpenSGDocExample>
>
> Findings: Preliminary testing indicates that separating the libraries does
> not decrease the time needed to build ALL of the library's documentation.
> However, building is faster on a per-library basis than when the build is
> not separated. The real benefit is realized when only part of the
> documentation needs to be rebuilt, in that case only the documentation of
> the changed library needs to be built. Also, given the size of some contrib
> libraries to OpenSG, mine in particular :), a single monolithic build takes
> a very long time, and can consume a large amount of memory.
>
> Future work: Currently there is no main html page that can be used to
> navigate between the separate documentation trees. I would like to create a
> template html file that would have a tree gui component that linked to each
> of the libraries documentation trees. This template html file would be
> filled with the correct structure and linking information during cmake
> configuration if the OSG_GENERATE_SEPARATE_LIB_DOC is on. Suggestions on
> other strategies?
>
> I am willing to help with any bugs, deficiencies, changes that this
> contribution may have/need if you choose to add it.
>
> Thanks,
> David Kabala
>
------------------------------------------------------------------------------
Special Offer-- Download ArcSight Logger for FREE (a $49 USD value)!
Finally, a world-class log management solution at an even better price-free!
Download using promo code Free_Logger_4_Dev2Dev. Offer expires
February 28th, so secure your free ArcSight Logger TODAY!
http://p.sf.net/sfu/arcsight-sfd2d
_______________________________________________
Opensg-core mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/opensg-core
