Commit 933db392 authored by Jan Möbius's avatar Jan Möbius

More documentation fixes

git-svn-id: http://www.openflipper.org/svnrepo/OpenFlipper/branches/Free@15112 383ad7c9-94d9-4d36-a494-682f7c89f535
parent 6f15b616
......@@ -79,7 +79,7 @@ namespace ACG {
//== CLASS DEFINITION =========================================================
/** \class GLState GLState.hh <ACG/Scenegraph/GLState.hh>
/** \class GLState <ACG/GL/GLState.hh>
This class stores all relevant OpenGL states and can therefore
provide some nice and efficient functions like projecting,
......
......@@ -64,7 +64,16 @@ namespace SceneGraph {
//== IMPLEMENTATION ==========================================================
/** \brief Find a node in the scene graph
*
*
* Traverse scenegraph starting at _root, looking for a node whose id
* is _node_idx . Returns 0 if node wasn't found.
*
* @param _root The root node where the traversal starts (not necessary the root node of the scenegraph)
* @param _node_idx The node index this function should look for
* @return 0 if the node was not found, otherwise a pointer to the node.
**/
BaseNode* find_node(BaseNode* _root, unsigned int _node_idx)
{
FindNodeAction action(_node_idx);
......
......@@ -499,16 +499,6 @@ private:
};
/** \brief Find a node in the scene graph
*
*
* Traverse scenegraph starting at _root, looking for a node whose id
* is _node_idx . Returns 0 if node wasn't found.
*
* @param _root The root node where the traversal starts (not necessary the root node of the scenegraph)
* @param _node_idx The node index this function should look for
* @return 0 if the node was not found, otherwise a pointer to the node.
**/
ACGDLLEXPORT
BaseNode* find_node( BaseNode* _root, unsigned int _node_idx );
......
......@@ -45,7 +45,13 @@
namespace ACG {
namespace SceneGraph {
/** \brief Analyze the SceneGraph <ACG/Scenegraph/SceneGraphAnalysis.hh>
*
* @param _root Root node of the scenegraph
* @param _maxPasses Returns the maximal number of render passes
* @param _bbmin Returns lower left of the bounding box
* @param _bbmax Returns upper right of the bounding box
*/
void analyzeSceneGraph(ACG::SceneGraph::BaseNode* _root,
unsigned int& _maxPasses,
ACG::Vec3d& _bbmin,
......
......@@ -64,13 +64,6 @@ namespace SceneGraph {
//== FORWARDDECLARATIONS ======================================================
/** \brief Analyze the SceneGraph <ACG/Scenegraph/BaseNode.hh>
*
* @param _root Root node of the scenegraph
* @param _maxPasses Returns the maximal number of render passes
* @param _bbmin Returns lower left of the bounding box
* @param _bbmax Returns upper right of the bounding box
*/
ACGDLLEXPORT
void analyzeSceneGraph(ACG::SceneGraph::BaseNode* _root,
unsigned int& _maxPasses,
......@@ -81,4 +74,4 @@ void analyzeSceneGraph(ACG::SceneGraph::BaseNode* _root,
} // namespace SceneGraph
} // namespace ACG
//=============================================================================
#endif
#endif //SCENEGRAPHANALYSIS_HH
......@@ -92,7 +92,6 @@ public:
};
/// Compare function for sorting Strips depending on their texture index
bool ACGDLLEXPORT stripTextureCompare(const Strip& i,const Strip& j);
class ACGDLLEXPORT TextureRenderInfo {
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment