From 2be018230dbbc362bb0045c3a9b29c24b0dc1ec6 Mon Sep 17 00:00:00 2001 From: Robert Osfield Date: Tue, 5 Aug 2008 19:23:38 +0000 Subject: [PATCH] Merged improvements to namespace doxygen comments from svn/trunk. --- include/osgFX/Export | 2 +- include/osgIntrospection/Export | 8 ++++++++ include/osgManipulator/Export | 7 +++++++ include/osgParticle/Export | 2 +- include/osgShadow/Export | 2 +- include/osgSim/Export | 2 +- include/osgTerrain/Export | 6 +----- include/osgText/Export | 2 +- include/osgWidget/Export | 4 ++-- 9 files changed, 23 insertions(+), 12 deletions(-) diff --git a/include/osgFX/Export b/include/osgFX/Export index 97c55c966..36c66d803 100644 --- a/include/osgFX/Export +++ b/include/osgFX/Export @@ -31,7 +31,7 @@ \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 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. diff --git a/include/osgIntrospection/Export b/include/osgIntrospection/Export index ffa9a24a2..f19f72836 100644 --- a/include/osgIntrospection/Export +++ b/include/osgIntrospection/Export @@ -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. */ +/** + +\namespace Properties + +Properties is a set of helper definations used by the osgIntrospectoin wrappers. + +*/ + #endif diff --git a/include/osgManipulator/Export b/include/osgManipulator/Export index 65bd7c2b9..0bf7a114c 100644 --- a/include/osgManipulator/Export +++ b/include/osgManipulator/Export @@ -27,4 +27,11 @@ # define OSGMANIPULATOR_EXPORT #endif +/** + +\namespace osgManipulator + +The osgManipulator library is a NodeKit that extends the core scene graph to support 3D interactive manipulators. +*/ + #endif diff --git a/include/osgParticle/Export b/include/osgParticle/Export index 7d01eae01..63b37cf4a 100644 --- a/include/osgParticle/Export +++ b/include/osgParticle/Export @@ -42,7 +42,7 @@ \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. */ diff --git a/include/osgShadow/Export b/include/osgShadow/Export index e4b181d4a..c69e5f277 100644 --- a/include/osgShadow/Export +++ b/include/osgShadow/Export @@ -41,7 +41,7 @@ \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 diff --git a/include/osgSim/Export b/include/osgSim/Export index 5b6939cb8..d7e81ed55 100644 --- a/include/osgSim/Export +++ b/include/osgSim/Export @@ -50,7 +50,7 @@ \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. */ diff --git a/include/osgTerrain/Export b/include/osgTerrain/Export index 583f1fa34..f694642e0 100644 --- a/include/osgTerrain/Export +++ b/include/osgTerrain/Export @@ -41,11 +41,7 @@ \namespace osgTerrain -The osgTerrain is a utility library that provides geospecifc terrain database generation 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.. +The osgTerrain library is a NodeKit that provides geospecifc terrain rendering support. */ #endif diff --git a/include/osgText/Export b/include/osgText/Export index b988dc5f2..af86cb242 100644 --- a/include/osgText/Export +++ b/include/osgText/Export @@ -41,7 +41,7 @@ \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 diff --git a/include/osgWidget/Export b/include/osgWidget/Export index bdac50fe3..29b879f2e 100644 --- a/include/osgWidget/Export +++ b/include/osgWidget/Export @@ -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