[Gnash-commit] gnash ChangeLog server/as_environment.h

[Sandro Santilli]

CVSROOT:        /sources/gnash
Module name:    gnash
Changes by:     Sandro Santilli <strk>  06/09/21 09:31:12

Modified files:
        .              : ChangeLog 
        server         : as_environment.h 

Log message:
        doxygen comments

CVSWeb URLs:
http://cvs.savannah.gnu.org/viewcvs/gnash/ChangeLog?cvsroot=gnash&r1=1.888&r2=1.889
http://cvs.savannah.gnu.org/viewcvs/gnash/server/as_environment.h?cvsroot=gnash&r1=1.20&r2=1.21

Patches:
Index: ChangeLog
===================================================================
RCS file: /sources/gnash/gnash/ChangeLog,v
retrieving revision 1.888
retrieving revision 1.889
diff -u -b -r1.888 -r1.889
--- ChangeLog   21 Sep 2006 09:09:18 -0000      1.888
+++ ChangeLog   21 Sep 2006 09:31:11 -0000      1.889
@@ -1,5 +1,6 @@
 2006-09-21 Sandro Santilli  <address@hidden>
 
+       * server/as_environment.h: doxygen comments 
        * server/parser/edit_text_character_def.cpp: added comment
          about why we're doing the wrong thing with VariableName
          (related to bug#17806)

Index: server/as_environment.h
===================================================================
RCS file: /sources/gnash/gnash/server/as_environment.h,v
retrieving revision 1.20
retrieving revision 1.21
diff -u -b -r1.20 -r1.21
--- server/as_environment.h     21 Sep 2006 05:55:52 -0000      1.20
+++ server/as_environment.h     21 Sep 2006 09:31:12 -0000      1.21
@@ -36,7 +36,7 @@
 //
 //
 
-/* $Id: as_environment.h,v 1.20 2006/09/21 05:55:52 nihilus Exp $ */
+/* $Id: as_environment.h,v 1.21 2006/09/21 09:31:12 strk Exp $ */
 
 #ifndef GNASH_AS_ENVIRONMENT_H
 #define GNASH_AS_ENVIRONMENT_H
@@ -166,7 +166,10 @@
        /// Same of the above, but no support for path.
        as_value get_variable_raw(const tu_string& varname) const;
 
+       /// \brief
        /// Given a path to variable, set its value.
+       /// Variable name can contain path elements.
+       ///
        void    set_variable(const tu_string& path, const as_value& val);
 
        /// Given a variable name, set its value (no support for path)
@@ -231,6 +234,9 @@
        }
 
        /// Find the sprite/movie referenced by the given path.
+       //
+       /// Supports both /slash/syntax and dot.syntax
+       ///
        character* find_target(const tu_string& path) const;
 
        /// \brief
@@ -297,8 +303,24 @@
 
        int find_local(const tu_string& varname) const;
 
-       bool parse_path(const tu_string& var_path, tu_string* path,
-               tu_string* var) const;
+       // See if the given variable name is actually a sprite path
+       // followed by a variable name.  These come in the format:
+       //
+       //      /path/to/some/sprite/:varname
+       //
+       // (or same thing, without the last '/')
+       //
+       // or
+       //      path.to.some.var
+       //
+       // If that's the format, puts the path part (no colon or
+       // trailing slash) in *path, and the varname part (no colon)
+       // in *var and returns true.
+       //
+       // If no colon, returns false and leaves *path & *var alone.
+       //
+       bool parse_path(const tu_string& var_path, tu_string& path,
+               tu_string& var) const;
 
        /// Given a variable name, set its value (no support for path)
        void set_variable_raw(const tu_string& path, const as_value& val,