Changeset 1584

Timestamp:

03/02/10 13:43:43 (3 years ago)

Author:

mauser

Message:

added more comments to action.cpp

Files:

• branches/advancedMidiLearn/libs/hydrogen/src/action.cpp (modified) (2 diffs)

branches/advancedMidiLearn/libs/hydrogen/src/action.cpp

@@ -40 +40 @@
 
 /* Class Action */
-Action::Action( QString s ) : Object( "Action" ) {
-        type = s;
+Action::Action( QString typeString ) : Object( "Action" ) {
+
+        /*
+            An "Action" is something which can be interpreted and executed by hydrogen.
+            Example: If hydrogen executes the Action with type "MUTE", it will mute the outputs.
+
+            The two parameters are optional and can be used to carry additional informations, which mean
+            only something to this very Action. They can have totally different meanings for other Actions.
+            Example: parameter1 is the Mixer strip and parameter 2 the volume change on this strip
+        */
+
+        type = typeString;
         QString parameter1 = "0";
         QString parameter2 = "0" ;
@@ -53 +63 @@
         __instance = this;
         
+        /*
+            the actionList holds all Action identfiers hydrogen is able to interpret.
+        */
         actionList <<""
         << "PLAY"