Changeset 57944 in vbox for trunk/include/iprt/cpp

Timestamp:

Sep 29, 2015 3:07:09 PM (9 years ago)

Author:

vboxsync

Message:

iprt: More doxygen corrections.

Location:

trunk/include/iprt/cpp

Files:

• list.h (modified) (4 diffs)
• ministring.h (modified) (3 diffs)
• mtlist.h (modified) (3 diffs)
• xml.h (modified) (1 diff)

trunk/include/iprt/cpp/list.h

@@ -208 +208 @@
      * This preallocates @a cCapacity elements within the list.
      *
-     * @param   cCapacitiy   The initial capacity the list has.
+     * @param   cCapacity    The initial capacity the list has.
      * @throws  std::bad_alloc
      */
@@ -924 +924 @@
      * This preallocates @a cCapacity elements within the list.
      *
-     * @param   cCapacitiy   The initial capacity the list has.
+     * @param   cCapacity    The initial capacity the list has.
      * @throws  std::bad_alloc
      */
@@ -955 +955 @@
      * This preallocates @a cCapacity elements within the list.
      *
-     * @param   cCapacitiy   The initial capacity the list has.
+     * @param   cCapacity    The initial capacity the list has.
      * @throws  std::bad_alloc
      */
@@ -983 +983 @@
      * This preallocates @a cCapacity elements within the list.
      *
-     * @param   cCapacitiy   The initial capacity the list has.
+     * @param   cCapacity    The initial capacity the list has.
      * @throws  std::bad_alloc
      */

trunk/include/iprt/cpp/ministring.h

@@ -428 +428 @@
      * Shortcut to append(), char variant.
      *
-     * @param pszThat           The character to append.
+     * @param ch                The character to append.
      *
      * @returns                 Reference to the object.
      */
-    RTCString &operator+=(char c)
-    {
-        return append(c);
+    RTCString &operator+=(char ch)
+    {
+        return append(ch);
     }
 
@@ -603 +603 @@
      * Compares the member string to another RTCString.
      *
-     * @param   pcszThat    The string to compare with.
+     * @param   rThat       The string to compare with.
      * @param   cs          Whether comparison should be case-sensitive.
      * @returns 0 if equal, negative if this is smaller than @a pcsz, positive
      *          if larger.
      */
-    int compare(const RTCString &that, CaseSensitivity cs = CaseSensitive) const
+    int compare(const RTCString &rThat, CaseSensitivity cs = CaseSensitive) const
     {
         if (cs == CaseSensitive)
-            return ::RTStrCmp(m_psz, that.m_psz);
-        return ::RTStrICmp(m_psz, that.m_psz);
+            return ::RTStrCmp(m_psz, rThat.m_psz);
+        return ::RTStrICmp(m_psz, rThat.m_psz);
     }
 
@@ -619 +619 @@
      *
      * @returns true if equal, false if not.
-     * @param   that    The string to compare with.
-     */
-    bool equals(const RTCString &that) const
-    {
-        return that.length() == length()
-            && memcmp(that.m_psz, m_psz, length()) == 0;
+     * @param   rThat    The string to compare with.
+     */
+    bool equals(const RTCString &rThat) const
+    {
+        return rThat.length() == length()
+            && memcmp(rThat.m_psz, m_psz, length()) == 0;
     }
 

trunk/include/iprt/cpp/mtlist.h

@@ -101 +101 @@
      * This preallocates @a cCapacity elements within the list.
      *
-     * @param   cCapacitiy   The initial capacity the list has.
+     * @param   cCapacity    The initial capacity the list has.
      * @throws  std::bad_alloc
      */
@@ -129 +129 @@
      * This preallocates @a cCapacity elements within the list.
      *
-     * @param   cCapacitiy   The initial capacity the list has.
+     * @param   cCapacity    The initial capacity the list has.
      * @throws  std::bad_alloc
      */
@@ -157 +157 @@
      * This preallocates @a cCapacity elements within the list.
      *
-     * @param   cCapacitiy   The initial capacity the list has.
+     * @param   cCapacity    The initial capacity the list has.
      * @throws  std::bad_alloc
      */

trunk/include/iprt/cpp/xml.h

@@ -601 +601 @@
      *                              simple path to any decendant.
      * @param   pcszAttribute       The attribute name.
-     * @param   pcszPathNamespace   The namespace to match @pcszPath with, NULL
+     * @param   pcszPathNamespace   The namespace to match @a pcszPath with, NULL
      *                              (default) match any namespace.  When using a
      *                              path, this matches all elements along the way.
-     * @param   pcszAttribNamespace The namespace prefix to apply to the attribute,
-     *                              NULL (default) match any namespace.
+     * @param   pcszAttributeNamespace  The namespace prefix to apply to the
+     *                              attribute, NULL (default) match any namespace.
      * @see     findChildElementP and findAttributeValue
      */