Commit 1ec87869 authored by hybrid's avatar hybrid

Some documentation fixes.

git-svn-id: svn://svn.code.sf.net/p/irrlicht/code/trunk@1785 dfc29bdd-3216-0410-991c-e03cc46cb475
parent 5fed90d3
...@@ -30,31 +30,31 @@ namespace gui ...@@ -30,31 +30,31 @@ namespace gui
//! adds an element to the gui environment based on its type id //! adds an element to the gui environment based on its type id
/** \param type: Type of the element to add. /** \param type: Type of the element to add.
\param parent: Parent scene node of the new element, can be null to add to the root. \param parent: Parent scene node of the new element, can be null to add to the root.
\return Returns pointer to the new element or null if not successful. */ \return Pointer to the new element or null if not successful. */
virtual IGUIElement* addGUIElement(EGUI_ELEMENT_TYPE type, IGUIElement* parent=0) = 0; virtual IGUIElement* addGUIElement(EGUI_ELEMENT_TYPE type, IGUIElement* parent=0) = 0;
//! adds a GUI element to the GUI Environment based on its type name //! adds a GUI element to the GUI Environment based on its type name
/** \param typeName: Type name of the element to add. /** \param typeName: Type name of the element to add.
\param parent: Parent scene node of the new element, can be null to add it to the root. \param parent: Parent scene node of the new element, can be null to add it to the root.
\return Returns pointer to the new element or null if not successful. */ \return Pointer to the new element or null if not successful. */
virtual IGUIElement* addGUIElement(const c8* typeName, IGUIElement* parent=0) = 0; virtual IGUIElement* addGUIElement(const c8* typeName, IGUIElement* parent=0) = 0;
//! returns amount of GUI element types this factory is able to create //! Get amount of GUI element types this factory is able to create
virtual s32 getCreatableGUIElementTypeCount() const = 0; virtual s32 getCreatableGUIElementTypeCount() const = 0;
//! returns type of a createable element type //! Get type of a createable element type
/** \param idx: Index of the element type in this factory. Must be a value between 0 and /** \param idx: Index of the element type in this factory. Must be a value between 0 and
getCreatableGUIElementTypeCount() */ getCreatableGUIElementTypeCount() */
virtual EGUI_ELEMENT_TYPE getCreateableGUIElementType(s32 idx) const = 0; virtual EGUI_ELEMENT_TYPE getCreateableGUIElementType(s32 idx) const = 0;
//! returns type name of a createable GUI element type by index //! Get type name of a createable GUI element type by index
/** \param idx: Index of the type in this factory. Must be a value between 0 and /** \param idx: Index of the type in this factory. Must be a value between 0 and
getCreatableGUIElementTypeCount() */ getCreatableGUIElementTypeCount() */
virtual const c8* getCreateableGUIElementTypeName(s32 idx) const = 0; virtual const c8* getCreateableGUIElementTypeName(s32 idx) const = 0;
//! returns type name of a createable GUI element //! returns type name of a createable GUI element
/** \param type: Type of GUI element. /** \param type: Type of GUI element.
\return: Returns name of the type if this factory can create the type, otherwise 0. */ \return Name of the type if this factory can create the type, otherwise 0. */
virtual const c8* getCreateableGUIElementTypeName(EGUI_ELEMENT_TYPE type) const = 0; virtual const c8* getCreateableGUIElementTypeName(EGUI_ELEMENT_TYPE type) const = 0;
}; };
......
...@@ -488,7 +488,8 @@ namespace scene ...@@ -488,7 +488,8 @@ namespace scene
//! Sets if debug data like bounding boxes should be drawn. //! Sets if debug data like bounding boxes should be drawn.
/** A bitwise OR of the types is supported. /** A bitwise OR of the types from
irr::scene::E_DEBUG_SCENE_TYPE is supported.
Please note that not all scene nodes support this feature. Please note that not all scene nodes support this feature.
\param state The debug data visibility state to be used. */ \param state The debug data visibility state to be used. */
virtual void setDebugDataVisible(s32 state) virtual void setDebugDataVisible(s32 state)
...@@ -497,7 +498,8 @@ namespace scene ...@@ -497,7 +498,8 @@ namespace scene
} }
//! Returns if debug data like bounding boxes are drawn. //! Returns if debug data like bounding boxes are drawn.
/** \return A bitwise OR of the debug data values currently visible. */ /** \return A bitwise OR of the debug data values from
irr::scene::E_DEBUG_SCENE_TYPE which are currently enabled. */
s32 isDebugDataVisible() const s32 isDebugDataVisible() const
{ {
return DebugDataVisible; return DebugDataVisible;
......
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