[Gnash-commit] /srv/bzr/gnash/trunk r10155: Fix doxygen comment (hint: @tparam is for template parameters)

[Sandro Santilli]

------------------------------------------------------------
revno: 10155
committer: Sandro Santilli <address@hidden>
branch nick: trunk
timestamp: Mon 2008-10-27 20:52:42 +0100
message:
  Fix doxygen comment (hint: @tparam is for template parameters)
modified:
  libcore/as_object.h

=== modified file 'libcore/as_object.h'
--- a/libcore/as_object.h       2008-10-25 18:51:18 +0000
+++ b/libcore/as_object.h       2008-10-27 19:52:42 +0000
@@ -165,6 +165,9 @@
        ///
        /// @param name
        /// The string id to look for
+    ///
+       /// @param nsname
+       /// The namespace id to look for, 0 for any.
        ///
        /// @param owner
        /// If not null, this is set to the object which contained the property.
@@ -538,9 +541,21 @@
        /// The arguments are the same as the above init_property arguments,
        /// although the setter argument is omitted.
        ///
+       /// @param key
+    ///     Property name id
+    ///
+    /// @param getter
+    ///     The getter function
+    ///
+    /// @param flags
+    ///     Property flags
+    ///
        /// @param nsname
-       /// The id of the namespace to which this member belongs. 0 is a 
wildcard
-       /// and will be matched by anything not asking for a specific namespace.
+       ///     The id of the namespace to which this member belongs.
+    ///     0 is a wildcard and will be matched by anything not asking
+    ///     for a specific namespace.
+    ///
+    ///
        void init_readonly_property(const std::string& key, as_function& getter,
                        int 
flags=as_prop_flags::dontDelete|as_prop_flags::dontEnum,
                        string_table::key nsname = 0);
@@ -549,7 +564,6 @@
                        int 
flags=as_prop_flags::dontDelete|as_prop_flags::dontEnum,
                        string_table::key nsname = 0);
 
-       /// \brief
        /// Use this method for read-only properties.
        //
        /// This method achieves the same as the above init_property method.
@@ -560,9 +574,20 @@
        /// The arguments are the same as the above init_property arguments,
        /// although the setter argument is omitted.
        ///
+       /// @param key
+    ///     Property name id
+    ///
+    /// @param getter
+    ///     The getter function
+    ///
+    /// @param flags
+    ///     Property flags
+    ///
        /// @param nsname
-       /// The id of the namespace to which this member belongs. 0 is a 
wildcard
-       /// and will be matched by anything not asking for a specific namespace.
+       ///     The id of the namespace to which this member belongs.
+    ///     0 is a wildcard and will be matched by anything not asking
+    ///     for a specific namespace.
+    ///
        void init_readonly_property(const std::string& key, as_c_function_ptr 
getter,
                        int 
flags=as_prop_flags::dontDelete|as_prop_flags::dontEnum,
                        string_table::key nsname = 0);
@@ -693,12 +718,6 @@
        ///     if the current VM is initialized for a  target
        ///     up to SWF6.
        ///
-       /// @param env
-       ///     The environment to use for setting up call frame stack
-       ///
-       /// @param nargs
-       ///     Number of arguments
-       ///
        /// @param ...
        ///     nargs as_value references
        ///
@@ -716,7 +735,7 @@
        //
        /// This function does *not* recurse in this object's prototype.
        ///
-       /// @parame name
+       /// @param name
        ///     Name of the property.
        ///     Case insensitive up to SWF6,
        ///     case *sensitive* from SWF7 up.
@@ -739,7 +758,7 @@
        //
        /// This function does *not* recurse in this object's prototype.
        ///
-       /// @parame name
+       /// @param name
        ///     Name of the property.
        ///     Case insensitive up to SWF6,
        ///     case *sensitive* from SWF7 up.
@@ -756,7 +775,7 @@
 
        /// Return true if this object has the named property
        //
-       /// @parame name
+       /// @param name
        ///     Name of the property.
        ///     Case insensitive up to SWF6,
        ///     case *sensitive* from SWF7 up.
@@ -1001,7 +1020,7 @@
        //
        /// There is no point to make this function
        /// protected or private, as a call to the
-       /// public: set_member("__proto__", <anyting>)
+       /// public: set_member("__proto__", anyting)
        /// will do just the same
        ///
        void set_prototype(boost::intrusive_ptr<as_object> proto, int 
flags=as_prop_flags::dontDelete|as_prop_flags::dontEnum);
@@ -1067,9 +1086,11 @@
        TriggerContainer _trigs;
 };
 
-/// Template which does a dynamic cast for as_object pointers. It throws an
-/// exception if the dynamic cast fails.
-/// @param T the class to which the obj pointer should be cast.
+/// Template which does a dynamic cast for as_object pointers.
+//
+/// It throws an exception if the dynamic cast fails.
+///
+/// @tparam T the class to which the obj pointer should be cast.
 /// @param obj the pointer to be cast.
 /// @return If the cast succeeds, the pointer cast to the requested type.
 ///         Otherwise, NULL.