[Gnash-commit] gnash ./ChangeLog libbase/zlib_adapter.h

[Sandro Santilli]

CVSROOT:        /sources/gnash
Module name:    gnash
Branch:         
Changes by:     Sandro Santilli <address@hidden>        06/05/09 17:08:51

Modified files:
        .              : ChangeLog 
        libbase        : zlib_adapter.h 

Log message:
        Doxygen comments

CVSWeb URLs:
http://cvs.savannah.gnu.org/viewcvs/gnash/gnash/ChangeLog.diff?tr1=1.284&tr2=1.285&r1=text&r2=text
http://cvs.savannah.gnu.org/viewcvs/gnash/gnash/libbase/zlib_adapter.h.diff?tr1=1.1&tr2=1.2&r1=text&r2=text

Patches:
Index: gnash/ChangeLog
diff -u gnash/ChangeLog:1.284 gnash/ChangeLog:1.285
--- gnash/ChangeLog:1.284       Tue May  9 16:55:39 2006
+++ gnash/ChangeLog     Tue May  9 17:08:51 2006
@@ -1,5 +1,6 @@
 2006-05-09 Sandro Santilli <address@hidden>
 
+       * libbase/zlib_adapter.h: doxygen comments
        * server/stream.h, server/stream.cpp: doxygen comments
        * server/sprite_definition.h, server/sprite_definition.cpp,
        server/impl.cpp: modified sprite_definition constructor to
Index: gnash/libbase/zlib_adapter.h
diff -u gnash/libbase/zlib_adapter.h:1.1 gnash/libbase/zlib_adapter.h:1.2
--- gnash/libbase/zlib_adapter.h:1.1    Tue Dec 20 20:57:00 2005
+++ gnash/libbase/zlib_adapter.h        Tue May  9 17:08:51 2006
@@ -3,9 +3,6 @@
 // This source code has been donated to the Public Domain.  Do
 // whatever you want with it.
 
-// Code to wrap zlib compression/decompression around a tu_file
-// stream.
-
 
 #ifndef ZLIB_ADAPTER_H
 #define ZLIB_ADAPTER_H
@@ -15,23 +12,26 @@
 class tu_file;
 
 
+/// Code to wrap zlib compression/decompression around a tu_file stream.
 namespace zlib_adapter
 {
        // NOTE: these functions will return NULL if
        // TU_CONFIG_LINK_TO_ZLIB is set to 0.
 
-       // Returns a read-only tu_file stream that inflates the remaining
-       // content of the given input stream, as you read data from the
-       // new stream.
+       /// \brief
+       /// Returns a read-only tu_file stream that inflates the remaining
+       /// content of the given input stream, as you read data from the
+       /// new stream.
        //
-       // The caller owns the returned tu_file*.  The caller also owns
-       // the input tu_file*; don't delete it until you've deleted the
-       // returned tu_file.
-       // @@ Here's a good case for ref-counting...
+       /// The caller owns the returned tu_file*.  The caller also owns
+       /// the input tu_file*; don't delete it until you've deleted the
+       /// returned tu_file.
+       /// @@ Here's a good case for ref-counting...
        tu_file*        make_inflater(tu_file* in);
 
-       // Returns a write-only tu_file stream that deflates the remaining
-       // content of the given input stream.
+       /// \brief
+       /// Returns a write-only tu_file stream that deflates the remaining
+       /// content of the given input stream.
        tu_file*        make_deflater(tu_file* out);
 }