Improved the doxygen docs over the various namespaces

This commit is contained in:
Robert Osfield 2008-08-05 19:17:09 +00:00
parent 4584cf2440
commit 6f6f56c795
9 changed files with 23 additions and 12 deletions

View File

@ -31,7 +31,7 @@
\namespace osgFX \namespace osgFX
The osgFX is a NodeKit library that extends the core scene graph to provide a special effects framework. The osgFX library is a NodeKit that extends the core scene graph to provide a special effects framework.
osgFX's framework allows multiple rendering techniques to be provide for each effect, thereby provide the use osgFX's framework allows multiple rendering techniques to be provide for each effect, thereby provide the use
appropriate rendering techniques for each different class of graphics hardware, i.e. support for both modern appropriate rendering techniques for each different class of graphics hardware, i.e. support for both modern
programmable graphics hardware and still have standard OpenGL 1.1 support as a fallback. programmable graphics hardware and still have standard OpenGL 1.1 support as a fallback.

View File

@ -60,4 +60,12 @@ automatically generated by parsing header files via gen_wrapper utility. All th
core OpenSceneGraph libraries have pre built wrappers available for you use. core OpenSceneGraph libraries have pre built wrappers available for you use.
*/ */
/**
\namespace Properties
Properties is a set of helper definations used by the osgIntrospectoin wrappers.
*/
#endif #endif

View File

@ -27,4 +27,11 @@
# define OSGMANIPULATOR_EXPORT # define OSGMANIPULATOR_EXPORT
#endif #endif
/**
\namespace osgManipulator
The osgManipulator library is a NodeKit that extends the core scene graph to support 3D interactive manipulators.
*/
#endif #endif

View File

@ -42,7 +42,7 @@
\namespace osgParticle \namespace osgParticle
The osgParticle is a NodeKit library that extends the core scene graph to support particle effects. The osgParticle library is a NodeKit that extends the core scene graph to support particle effects.
*/ */

View File

@ -41,7 +41,7 @@
\namespace osgShadow \namespace osgShadow
The osgShadow is a NodeKit library that extends the core scene graph to add support for a range of shadow techniques. The osgShadow library is a NodeKit that extends the core scene graph to add support for a range of shadow techniques.
*/ */
#endif #endif

View File

@ -50,7 +50,7 @@
\namespace osgSim \namespace osgSim
The osgSim is a NodeKit library that extends the core scene graph to support nodes and drawables that specific to the visual simulation, such The osgSim library is a NodeKit that extends the core scene graph to support nodes and drawables that specific to the visual simulation, such
a navigational light point support and OpenFlight style degrees of freedom transform. a navigational light point support and OpenFlight style degrees of freedom transform.
*/ */

View File

@ -41,11 +41,7 @@
\namespace osgTerrain \namespace osgTerrain
The osgTerrain is a utility library that provides geospecifc terrain database generation support. The osgTerrain library is a NodeKit that provides geospecifc terrain rendering support.
The osgTerrain library is typically invoked by the osgdem utlitly application that users can use to build paged terrain databases
from geospecific imagery and digial elevation maps (DEM's). osgTerrain may also be used directly in your own applications to generate
databases. Note, osgTerrain is not presently written for run-time rendering of terrain, and is just focused on database
generation, these generated databases then can used used in standard OpenSceneGraph application which do not need to link osgTerrain..
*/ */
#endif #endif

View File

@ -41,7 +41,7 @@
\namespace osgText \namespace osgText
The osgText is a NodeKit library that extends the core scene graph to support high quality text. The osgText library is a NodeKit that extends the core scene graph to support high quality text.
*/ */
#endif #endif

View File

@ -39,9 +39,9 @@
/** /**
\namespace osgWidet \namespace osgWidget
The osgWidget is a NodeKit library that extends the core scene graph to support 3D widget set. The osgWidget library is a NodeKit that extends the core scene graph to support 3D GUI widget set.
*/ */
#endif #endif