Changeset 145 for osgVisual/include/util

Timestamp:

Nov 1, 2010, 7:23:10 PM (14 years ago)

Author:

Torben Dannhauer

Message:

 

File:

• osgVisual/include/util/visual_util.h (modified) (1 diff)

osgVisual/include/util/visual_util.h

@@ -220 +220 @@
         static bool setTransparentWindowBackground(osgViewer::Viewer* viewer_);
 
-        // Parses for the XML node of the specified module. The caller has to clean up if ret_value!=NULL, otherwise this function cleans up.
-        // nötige cleanup-Schritte:       xmlFreeDoc(doc); xmlCleanupParser();
+        /**
+         * \brief  Parses for the XML node of the specified module.The caller has to clean up the xmlDoc and the parser, beside it returns NULL because the queried modules is not configured.
+         * 
+         * To clean up, call this two functions:
+         *  xmlFreeDoc(doc);
+         *  xmlCleanupParser();
+         * 
+         * Example to use this function: 
+         *      xmlDoc* tmpDoc;
+         *  xmlNode* yourNode = util::getModuleXMLConfig( configFilename, "core", tmpDoc );
+         *  // use yourNode
+         *  if(tmpDoc)
+         *  {
+         *     xmlFreeDoc(tmpDoc); xmlCleanupParser();
+         *  }
+         * 
+         * @param configFilename : Config Filename to parse.
+         * @param moduleName : Module name to search for.
+         * @param doc : xmlDoc to use. Must be created outside that the caller can clean it up.
+         * @return : NULL on error, otherwise pointer to the xmlNode of the queried module.
+         */ 
         static xmlNode* getModuleXMLConfig(std::string configFilename, std::string moduleName, xmlDoc*& doc);
 
 private: 
+        /**
+         * \brief This functions checks a list of nodes and all of its children for the specified module configuration.
+         * 
+         * This function is used by getModuleXMLConfig() and works recursive
+         * 
+         * @param node : Node to search in
+         * @param moduleName :Module name to search for.
+         * @return : NULL if the module configuration was not found, otherwise pointer to the XML Node with the configuration for the specified module. 
+         */ 
         static xmlNode* checkXMLNodeChildrenForModule(xmlNode* node, std::string moduleName);
 };