Changeset 33469 in vbox for trunk/src

Timestamp:

Oct 26, 2010 1:43:40 PM (14 years ago)

Author:

vboxsync

Message:

IPRT: xml classes documentation, plus reduced some buffer sizes.

File:

• trunk/src/VBox/Runtime/r3/xml.cpp (modified) (10 diffs)

trunk/src/VBox/Runtime/r3/xml.cpp

@@ -468 +468 @@
 }
 
+/**
+ * Private implementation.
+ * @param elmRoot
+ */
 void Node::buildChildren(const ElementNode &elmRoot)       // private
 {
@@ -646 +650 @@
 }
 
+/**
+ * Private element constructor.
+ * @param pelmRoot
+ * @param pParent
+ * @param plibNode
+ */
 ElementNode::ElementNode(const ElementNode *pelmRoot,
                          Node *pParent,
@@ -999 +1009 @@
 
 /**
- * Sets the given attribute.
+ * Sets the given attribute; overloaded version for const char *.
  *
  * If an attribute with the given name exists, it is overwritten,
@@ -1043 +1053 @@
 }
 
+/**
+ * Sets the given attribute; overloaded version for int32_t.
+ *
+ * If an attribute with the given name exists, it is overwritten,
+ * otherwise a new attribute is created. Returns the attribute node
+ * that was either created or changed.
+ *
+ * @param pcszName
+ * @param i
+ * @return
+ */
 AttributeNode* ElementNode::setAttribute(const char *pcszName, int32_t i)
 {
-    char szValue[64];
+    char szValue[10];
     RTStrPrintf(szValue, sizeof(szValue), "%RI32", i);
     AttributeNode *p = setAttribute(pcszName, szValue);
@@ -1051 +1072 @@
 }
 
+/**
+ * Sets the given attribute; overloaded version for uint32_t.
+ *
+ * If an attribute with the given name exists, it is overwritten,
+ * otherwise a new attribute is created. Returns the attribute node
+ * that was either created or changed.
+ *
+ * @param pcszName
+ * @param u
+ * @return
+ */
 AttributeNode* ElementNode::setAttribute(const char *pcszName, uint32_t u)
 {
-    char szValue[64];
+    char szValue[10];
     RTStrPrintf(szValue, sizeof(szValue), "%RU32", u);
     AttributeNode *p = setAttribute(pcszName, szValue);
@@ -1059 +1091 @@
 }
 
+/**
+ * Sets the given attribute; overloaded version for int64_t.
+ *
+ * If an attribute with the given name exists, it is overwritten,
+ * otherwise a new attribute is created. Returns the attribute node
+ * that was either created or changed.
+ *
+ * @param pcszName
+ * @param i
+ * @return
+ */
 AttributeNode* ElementNode::setAttribute(const char *pcszName, int64_t i)
 {
-    char szValue[64];
+    char szValue[20];
     RTStrPrintf(szValue, sizeof(szValue), "%RI64", i);
     AttributeNode *p = setAttribute(pcszName, szValue);
@@ -1067 +1110 @@
 }
 
+/**
+ * Sets the given attribute; overloaded version for uint64_t.
+ *
+ * If an attribute with the given name exists, it is overwritten,
+ * otherwise a new attribute is created. Returns the attribute node
+ * that was either created or changed.
+ *
+ * @param pcszName
+ * @param u
+ * @return
+ */
 AttributeNode* ElementNode::setAttribute(const char *pcszName, uint64_t u)
 {
-    char szValue[64];
+    char szValue[20];
     RTStrPrintf(szValue, sizeof(szValue), "%RU64", u);
     AttributeNode *p = setAttribute(pcszName, szValue);
@@ -1075 +1129 @@
 }
 
+/**
+ * Sets the given attribute to the given uint32_t, outputs a hexadecimal string.
+ *
+ * If an attribute with the given name exists, it is overwritten,
+ * otherwise a new attribute is created. Returns the attribute node
+ * that was either created or changed.
+ *
+ * @param pcszName
+ * @param u
+ * @return
+ */
 AttributeNode* ElementNode::setAttributeHex(const char *pcszName, uint32_t u)
 {
-    char szValue[64];
+    char szValue[10];
     RTStrPrintf(szValue, sizeof(szValue), "0x%RX32", u);
     AttributeNode *p = setAttribute(pcszName, szValue);
@@ -1083 +1148 @@
 }
 
+/**
+ * Sets the given attribute; overloaded version for bool.
+ *
+ * If an attribute with the given name exists, it is overwritten,
+ * otherwise a new attribute is created. Returns the attribute node
+ * that was either created or changed.
+ *
+ * @param pcszName
+ * @param i
+ * @return
+ */
 AttributeNode* ElementNode::setAttribute(const char *pcszName, bool f)
 {
@@ -1089 +1165 @@
 
 /**
- * Private constructur for a new attribute node. This one is special:
+ * Private constructor for a new attribute node. This one is special:
  * in ppcszKey, it returns a pointer to a string buffer that should be
  * used to index the attribute correctly with namespaces.