[Gnash-commit] /srv/bzr/gnash/trunk r10154: fix doxygen warnings

[Sandro Santilli]

------------------------------------------------------------
revno: 10154
committer: Sandro Santilli <address@hidden>
branch nick: trunk
timestamp: Mon 2008-10-27 20:38:01 +0100
message:
  fix doxygen warnings
modified:
  libbase/SimpleBuffer.h
  libbase/string_table.h
  libcore/array.h

=== modified file 'libbase/SimpleBuffer.h'
--- a/libbase/SimpleBuffer.h    2008-09-15 13:55:30 +0000
+++ b/libbase/SimpleBuffer.h    2008-10-27 19:38:01 +0000
@@ -140,7 +140,7 @@
        /// The buffer will be appropriately resized to have space for
        /// the incoming data. The data will be copied.
        ///
-       /// @param newData
+       /// @param inData
        ///     Data to append. Will be copied.
        ///
        /// @param size
@@ -205,7 +205,7 @@
        /// The buffer will be appropriately resized to have space for
        /// the incoming data. The data will be copied.
        ///
-       /// @param newData
+       /// @param buf
        ///     SimpleBuffer containing data to append
        ///
        void append(const SimpleBuffer& buf)

=== modified file 'libbase/string_table.h'
--- a/libbase/string_table.h    2008-06-18 16:19:22 +0000
+++ b/libbase/string_table.h    2008-10-27 19:38:01 +0000
@@ -108,8 +108,9 @@
        /// @return The assigned key
        key insert(const std::string& to_insert);
 
-       /// \brief
-       /// Insert a group of strings with their ids preset. This allows
+       /// Insert a group of strings with their ids preset.
+    //
+    /// This allows
        /// for switches and enums and such, but be careful you don't set two
        /// strings with the same id, as this does not check for such 
occurrences.
        /// Converts the strings to lower case if mSetToLower is true.
@@ -118,6 +119,10 @@
        /// @param pList
        /// An array of svt objects, these should be fully constructed, 
including
        /// their ids.
+    ///
+       /// @param size
+    /// Number of elements in the svt objects array
+    ///
        void insert_group(svt* pList, std::size_t size);
 
        /// \brief
@@ -125,8 +130,11 @@
        /// be set to lower_case before addition.
        void lower_next_group() { mSetToLower = true; }
 
-       /// \brief
        /// Insert a string when you will handle the locking yourself.
+    //
+       /// @param to_insert
+    /// String to insert
+    ///
        /// @param lock
        /// Use lock_mutex to obtain the correct mutex to use for this -- using
        /// a different mutex will not be thread safe.

=== modified file 'libcore/array.h'
--- a/libcore/array.h   2008-09-24 15:46:11 +0000
+++ b/libcore/array.h   2008-10-27 19:38:01 +0000
@@ -152,6 +152,9 @@
 
        void set_indexed(unsigned int index, const as_value &v);
 
+       /// @param separator
+    ///     String to use as separator between elements
+    ///
        /// @param env
        ///     If not-null will be used to properl invoke the toString()
        ///     method against member values.