Changeset 316 for cpp/frams/param/param.h

Timestamp:

01/27/15 23:13:10 (10 years ago)

Author:

Maciej Komosinski

Message:

Improved documentation (for Param flags in particular)

File:

• cpp/frams/param/param.h (modified) (1 diff)

cpp/frams/param/param.h

@@ -18 +18 @@
 
 // ParamInterface flags:
-#define PARAM_READONLY  1
-#define PARAM_DONTSAVE  2
-#define PARAM_SETLEVEL(x) (((x)&3)<<2)
-#define PARAM_LEVEL(x) (((x)>>2)&3)
-#define PARAM_USERREADONLY 16
-#define PARAM_USERHIDDEN 32
-// for mutableparam (private!)
-#define MUTPARAM_ALLOCENTRY 64
-#define MUTPARAM_ALLOCDATA 128
-#define PARAM_NOSTATIC 256
-#define PARAM_CONST 512
-#define PARAM_CANOMITNAME 1024
-#define PARAM_DONTLOAD  2048
-#define PARAM_NOISOLATION       4096
-#define PARAM_DEPRECATED        8192
+#define PARAM_READONLY       1  //< Param is not able to change this member
+#define PARAM_DONTSAVE       2  //< Param will not save this member
+#define PARAM_SETLEVEL(x) (((x)&3)<<2)  //< internal use
+#define PARAM_LEVEL(x)    (((x)>>2)&3)  //< internal use
+#define PARAM_USERREADONLY  16  //< GUI should not change this member (even if Param can)
+#define PARAM_USERHIDDEN    32  //< GUI should not display this member
+#define MUTPARAM_ALLOCENTRY 64  //< for mutableparam (private!)
+#define MUTPARAM_ALLOCDATA 128  //< for mutableparam (private!)
+#define PARAM_NOSTATIC  256     //< (FramScript) don't access this member in a static object (ClassName.field)
+#define PARAM_CONST     512     //< (FramScript) constant value
+#define PARAM_CANOMITNAME 1024  //< affects Param::save2()/load2() - for example one-liners in f0 genetic encoding
+#define PARAM_DONTLOAD    2048  //< Param::load() skips this field
+#define PARAM_NOISOLATION 4096  //< don't use proxy object in master/slave interactions
+#define PARAM_DEPRECATED  8192  //< this member is deprecated
 
 typedef int32_t paInt;