[Gnash-commit] gnash ChangeLog server/parser/sound_definition.h

[Sandro Santilli]

CVSROOT:        /sources/gnash
Module name:    gnash
Changes by:     Sandro Santilli <strk>  07/11/23 23:47:36

Modified files:
        .              : ChangeLog 
        server/parser  : sound_definition.h 

Log message:
        document sound_sample a bit.

CVSWeb URLs:
http://cvs.savannah.gnu.org/viewcvs/gnash/ChangeLog?cvsroot=gnash&r1=1.4948&r2=1.4949
http://cvs.savannah.gnu.org/viewcvs/gnash/server/parser/sound_definition.h?cvsroot=gnash&r1=1.8&r2=1.9

Patches:
Index: ChangeLog
===================================================================
RCS file: /sources/gnash/gnash/ChangeLog,v
retrieving revision 1.4948
retrieving revision 1.4949
diff -u -b -r1.4948 -r1.4949
--- ChangeLog   23 Nov 2007 23:37:03 -0000      1.4948
+++ ChangeLog   23 Nov 2007 23:47:36 -0000      1.4949
@@ -1,5 +1,6 @@
 2007-11-23 Sandro Santilli <address@hidden>
 
+       * server/parser/sound_definition.h: document sound_sample a bit.
        * server/swf/StartSoundTag.{cpp,h}: some more cleanup (attempt).
 
 2007-11-23 Bastiaan Jacques <address@hidden>

Index: server/parser/sound_definition.h
===================================================================
RCS file: /sources/gnash/gnash/server/parser/sound_definition.h,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -b -r1.8 -r1.9
--- server/parser/sound_definition.h    23 Nov 2007 22:23:25 -0000      1.8
+++ server/parser/sound_definition.h    23 Nov 2007 23:47:36 -0000      1.9
@@ -32,11 +32,26 @@
 
 namespace gnash {
 
-/// TODO: document this
+/// This class is simply an identifier for a sound sample managed
+/// by a sound_handler, so should likely be defined in sound_handler.h
+///
+/// Definition tags will maintain a mapping between SWF-defined id
+/// of the sound and these identifiers.
+///
+/// Specifying an identifier for use by sound_handler would likely be
+/// claner, anyway this is what it is *currently*.
+///
+/// NOTE that the destructor of this identifier (thus becoming a "smart"
+/// identifier) requests the currently registered sound_handler removal
+/// of the identified sound_sample. This *might* be the reason why
+/// it is a ref-counted thing (hard to belive...).
+///
 //
 /// QUESTION: why is this a resource ?
 ///           does it really need to be ref-counted ?
 ///
+/// TODO: move definition to sound_handler.h and possibly nest inside 
sound_handler itself ?
+///
 class sound_sample: public resource
 {
 public:
@@ -48,6 +63,8 @@
        {
        }
 
+       /// delete the actual sound sample from the currently registered
+       /// sound handler.
        ~sound_sample();
 
        sound_sample* cast_to_sound_sample() { return this; }