fixed: Missing docs for new function in r26770.

git-svn-id: https://xbmc.svn.sourceforge.net/svnroot/xbmc/trunk@26771 568bbfeb-2a22-0410-94d2-cc84cf5bfa90

1 files changed, 13 insertions, 0 deletions

diff --git a/guilib/GUIControlFactory.h b/guilib/GUIControlFactory.h
index 221a2b8483..c4bb29e765 100644
--- a/guilib/GUIControlFactory.h
+++ b/guilib/GUIControlFactory.h
@@ -49,6 +49,19 @@ public:
   CGUIControl* Create(int parentID, const CRect &rect, TiXmlElement* pControlNode, bool insideContainer = false);
   void ScaleElement(TiXmlElement *element, RESOLUTION fileRes, RESOLUTION destRes);
   static bool GetFloat(const TiXmlNode* pRootNode, const char* strTag, float& value);
+
+  /*! \brief grab a dimension out of the XML
+   
+   Supports plain reading of a number (or constant) and, in addition allows "auto" as the value
+   for the dimension, whereby value is set to the max attribute (if it exists) and min is set the min
+   attribute (if it exists) or 1.  Auto values are thus detected by min != 0.
+
+   \param pRootNode XML node to read
+   \param strTag tag within pRootNode to read
+   \param value value to set, or maximum value if using auto
+   \param min minimum value - set != 0 if auto is used.
+   \return true if we found and read the tag.
+   */
   static bool GetDimension(const TiXmlNode* pRootNode, const char* strTag, float &value, float &min);
   static bool GetUnsigned(const TiXmlNode* pRootNode, const char* strTag, unsigned int& value);
   static bool GetAspectRatio(const TiXmlNode* pRootNode, const char* strTag, CAspectRatio &aspectRatio);