[prev in list] [next in list] [prev in thread] [next in thread] 

List:       kde-commits
Subject:    koffice/libs/store
From:       Elvis Stansvik <elvstone () gmail ! com>
Date:       2009-01-27 9:03:54
Message-ID: 1233047034.094668.4056.nullmailer () svn ! kde ! org
[Download RAW message or body]

SVN commit 917223 by astan:

Document the forEachElement macro explicitly.


 M  +14 -0     KoXmlReader.h  


--- trunk/koffice/libs/store/KoXmlReader.h #917222:917223
@@ -411,6 +411,20 @@
                                 int* errorLine = 0, int* errorColumn = 0);
 }
 
+/**
+ * \def forEachElement( elem, parent )
+ * \brief Loop through all child elements of \parent.
+ * This convenience macro is used to implement the forEachElement loop.
+ * The \elem parameter is a name of a QDomElement variable and the \parent
+ * is the name of the parent element. For example:
+ *
+ * QDomElement e;
+ * forEachElement( e, parent )
+ * {
+ *     kDebug() << e.localName() << " element found.";
+ *     ...
+ * }
+ */
 #define forEachElement( elem, parent ) \
     for ( KoXmlNode _node = parent.firstChild(); !_node.isNull(); _node = _node.nextSibling() ) \
         if ( ( elem = _node.toElement() ).isNull() ) {} else
[prev in list] [next in list] [prev in thread] [next in thread]