[Gnash-commit] gnash ./ChangeLog server/stream.cpp server/stre...

[Sandro Santilli]

CVSROOT:        /sources/gnash
Module name:    gnash
Branch:         
Changes by:     Sandro Santilli <address@hidden>        06/05/09 16:55:39

Modified files:
        .              : ChangeLog 
        server         : stream.cpp stream.h 

Log message:
        * server/stream.h, server/stream.cpp: doxygen comments

CVSWeb URLs:
http://cvs.savannah.gnu.org/viewcvs/gnash/gnash/ChangeLog.diff?tr1=1.283&tr2=1.284&r1=text&r2=text
http://cvs.savannah.gnu.org/viewcvs/gnash/gnash/server/stream.cpp.diff?tr1=1.4&tr2=1.5&r1=text&r2=text
http://cvs.savannah.gnu.org/viewcvs/gnash/gnash/server/stream.h.diff?tr1=1.5&tr2=1.6&r1=text&r2=text

Patches:
Index: gnash/ChangeLog
diff -u gnash/ChangeLog:1.283 gnash/ChangeLog:1.284
--- gnash/ChangeLog:1.283       Tue May  9 16:07:52 2006
+++ gnash/ChangeLog     Tue May  9 16:55:39 2006
@@ -1,5 +1,6 @@
 2006-05-09 Sandro Santilli <address@hidden>
 
+       * server/stream.h, server/stream.cpp: doxygen comments
        * server/sprite_definition.h, server/sprite_definition.cpp,
        server/impl.cpp: modified sprite_definition constructor to
        automatically read the SWF stream.
Index: gnash/server/stream.cpp
diff -u gnash/server/stream.cpp:1.4 gnash/server/stream.cpp:1.5
--- gnash/server/stream.cpp:1.4 Tue May  9 15:34:16 2006
+++ gnash/server/stream.cpp     Tue May  9 16:55:39 2006
@@ -51,9 +51,6 @@
 
        
        int     stream::read_uint(int bitcount)
-       // Reads a bit-packed unsigned integer from the stream
-       // and returns it.  The given bitcount determines the
-       // number of bits to read.
        {
                assert(bitcount <= 32 && bitcount >= 0);
                        
@@ -97,9 +94,6 @@
 
 
        int     stream::read_sint(int bitcount)
-       // Reads a bit-packed little-endian signed integer
-       // from the stream.  The given bitcount determines the
-       // number of bits to read.
        {
                assert(bitcount <= 32 && bitcount >= 0);
 
@@ -146,9 +140,6 @@
 
 
        char*   stream::read_string()
-       // Reads *and new[]'s* the string from the given file.
-       // Ownership passes to the caller; caller must delete[] the
-       // string when it is done with it.
        {
                align();
 
@@ -173,9 +164,6 @@
 
 
        char*   stream::read_string_with_length()
-       // Reads *and new[]'s* the string from the given file.
-       // Ownership passes to the caller; caller must delete[] the
-       // string when it is done with it.
        {
                align();
 
@@ -200,14 +188,12 @@
 
 
        int     stream::get_position()
-       // Return our current (byte) position in the input stream.
        {
                return m_input->get_position();
        }
 
 
        void    stream::set_position(int pos)
-       // Set the file position to the given value.
        {
                align();
 
@@ -226,7 +212,6 @@
 
 
        int     stream::get_tag_end_position()
-       // Return the file position of the end of the current tag.
        {
                assert(m_tag_stack.size() > 0);
 
@@ -235,7 +220,6 @@
 
 
        SWF::tag_type stream::open_tag()
-       // Return the tag type.
        {
                align();
                int     tag_header = read_u16();
@@ -257,7 +241,6 @@
 
 
        void    stream::close_tag()
-       // Seek to the end of the most-recently-opened tag.
        {
                assert(m_tag_stack.size() > 0);
                int     end_pos = m_tag_stack.back();
Index: gnash/server/stream.h
diff -u gnash/server/stream.h:1.5 gnash/server/stream.h:1.6
--- gnash/server/stream.h:1.5   Tue May  9 15:34:16 2006
+++ gnash/server/stream.h       Tue May  9 16:55:39 2006
@@ -15,15 +15,26 @@
 class tu_file;
 
 namespace gnash {
-       // stream is used to encapsulate bit-packed file reads.
+
+       /// stream is used to encapsulate bit-packed file reads.
        class stream
        {
        public:
                stream(tu_file* input);
                ~stream();
 
+               /// \brief
+               /// Reads a bit-packed unsigned integer from the stream
+               /// and returns it.  The given bitcount determines the
+               /// number of bits to read.
                int     read_uint(int bitcount);
+
+               /// \brief
+               /// Reads a bit-packed little-endian signed integer
+               /// from the stream.  The given bitcount determines the
+               /// number of bits to read.
                int     read_sint(int bitcount);
+
                float   read_fixed();
                void    align();
 
@@ -41,16 +52,32 @@
                        return count;
                };
 
-               // For null-terminated string.
-               char*   read_string();  // reads *and new[]'s* the string -- 
ownership passes to caller!
-
-               // For string that begins with an 8-bit length code.
-               char*   read_string_with_length();      // reads *and new[]'s* 
the string -- ownership passes to caller!
+               /// \brief
+               /// Reads *and new[]'s* the string from the given file.
+               /// Ownership passes to the caller; caller must delete[] the
+               /// string when it is done with it.
+               char*   read_string();  
+
+               /// \brief
+               /// Reads *and new[]'s* the string from the given file.
+               /// Ownership passes to the caller; caller must delete[] the
+               /// string when it is done with it.
+               /// For string that begins with an 8-bit length code.
+               char*   read_string_with_length();
 
+               /// Return our current (byte) position in the input stream.
                int     get_position();
+
+               /// Set the file position to the given value.
                void    set_position(int pos);
+
+               /// Return the file position of the end of the current tag.
                int     get_tag_end_position();
+
+               /// Return the tag type.
                SWF::tag_type   open_tag();
+
+               /// Seek to the end of the most-recently-opened tag.
                void    close_tag();
 
                tu_file*        get_underlying_stream() { return m_input; }