diff options
author | Gabor X Toth <*@tg-x.net> | 2013-07-15 07:54:16 +0000 |
---|---|---|
committer | Gabor X Toth <*@tg-x.net> | 2013-07-15 07:54:16 +0000 |
commit | d6e993f8abf50bd8d9b637e0fad3b74e71a1850b (patch) | |
tree | 7df97bf55a526f835ef34d0741031aa3159eaf83 /src/include/gnunet_env_lib.h | |
parent | 0c4e64676857a0963d74588c0a20e5a54892fb67 (diff) | |
download | gnunet-d6e993f8abf50bd8d9b637e0fad3b74e71a1850b.tar.gz gnunet-d6e993f8abf50bd8d9b637e0fad3b74e71a1850b.zip |
env: doc; spaces
Diffstat (limited to 'src/include/gnunet_env_lib.h')
-rw-r--r-- | src/include/gnunet_env_lib.h | 30 |
1 files changed, 15 insertions, 15 deletions
diff --git a/src/include/gnunet_env_lib.h b/src/include/gnunet_env_lib.h index ae2e3e1f1..49d092a8f 100644 --- a/src/include/gnunet_env_lib.h +++ b/src/include/gnunet_env_lib.h | |||
@@ -30,34 +30,34 @@ | |||
30 | * Possible operations on PSYC state (persistent) and transient variables (per message). | 30 | * Possible operations on PSYC state (persistent) and transient variables (per message). |
31 | */ | 31 | */ |
32 | enum GNUNET_ENV_Operator | 32 | enum GNUNET_ENV_Operator |
33 | { | 33 | { |
34 | /** | 34 | /** |
35 | * Set value of a transient variable. | 35 | * Set value of a transient variable. |
36 | */ | 36 | */ |
37 | GNUNET_ENV_OP_SET = ':', | 37 | GNUNET_ENV_OP_SET = ':', |
38 | 38 | ||
39 | /** | 39 | /** |
40 | * Assign value for a persistent state variable. | 40 | * Assign value for a persistent state variable. |
41 | * | 41 | * |
42 | * If an assigned value is NULL, the variable is deleted. | 42 | * If an assigned value is NULL, the variable is deleted. |
43 | */ | 43 | */ |
44 | GNUNET_ENV_OP_ASSIGN = '=', | 44 | GNUNET_ENV_OP_ASSIGN = '=', |
45 | 45 | ||
46 | /** | 46 | /** |
47 | * Augment state variable. | 47 | * Augment state variable. |
48 | * | 48 | * |
49 | * Used for appending strings, adding numbers, and adding new items to a list or dictionary. | 49 | * Used for appending strings, adding numbers, and adding new items to a list or dictionary. |
50 | */ | 50 | */ |
51 | GNUNET_ENV_OP_AUGMENT = '+', | 51 | GNUNET_ENV_OP_AUGMENT = '+', |
52 | 52 | ||
53 | /** | 53 | /** |
54 | * Diminish state variable. | 54 | * Diminish state variable. |
55 | * | 55 | * |
56 | * Used for subtracting numbers, and removing items from a list or dictionary. | 56 | * Used for subtracting numbers, and removing items from a list or dictionary. |
57 | */ | 57 | */ |
58 | GNUNET_ENV_OP_DIMINISH = '-', | 58 | GNUNET_ENV_OP_DIMINISH = '-', |
59 | 59 | ||
60 | /** | 60 | /** |
61 | * Update state variable. | 61 | * Update state variable. |
62 | * | 62 | * |
63 | * Used for modifying a single item of a list or dictionary. | 63 | * Used for modifying a single item of a list or dictionary. |
@@ -66,7 +66,7 @@ enum GNUNET_ENV_Operator | |||
66 | }; | 66 | }; |
67 | 67 | ||
68 | 68 | ||
69 | /** | 69 | /** |
70 | * PSYC variable types. | 70 | * PSYC variable types. |
71 | */ | 71 | */ |
72 | enum GNUNET_ENV_Type | 72 | enum GNUNET_ENV_Type |
@@ -78,33 +78,33 @@ enum GNUNET_ENV_Type | |||
78 | }; | 78 | }; |
79 | 79 | ||
80 | 80 | ||
81 | /** | 81 | /** |
82 | * PSYC state modifier. | 82 | * PSYC state modifier. |
83 | */ | 83 | */ |
84 | struct GNUNET_ENV_Modifier { | 84 | struct GNUNET_ENV_Modifier { |
85 | /** | 85 | /** |
86 | * State operation. | 86 | * State operation. |
87 | */ | 87 | */ |
88 | GNUNET_ENV_Operator oper; | 88 | GNUNET_ENV_Operator oper; |
89 | 89 | ||
90 | /** | 90 | /** |
91 | * Variable name. | 91 | * Variable name. |
92 | */ | 92 | */ |
93 | const char *name; | 93 | const char *name; |
94 | 94 | ||
95 | /** | 95 | /** |
96 | * Size of @a value. | 96 | * Size of @a value. |
97 | */ | 97 | */ |
98 | size_t value_size; | 98 | size_t value_size; |
99 | 99 | ||
100 | /** | 100 | /** |
101 | * Value of variable. | 101 | * Value of variable. |
102 | */ | 102 | */ |
103 | const void *value; | 103 | const void *value; |
104 | }; | 104 | }; |
105 | 105 | ||
106 | 106 | ||
107 | /** | 107 | /** |
108 | * Environment for a message. | 108 | * Environment for a message. |
109 | * | 109 | * |
110 | * Contains modifiers. | 110 | * Contains modifiers. |
@@ -159,7 +159,7 @@ GNUNET_ENV_environment_get_modifiers (const struct GNUNET_ENV_Environment *env, | |||
159 | * @param modifiers_length Number of @a modifiers. | 159 | * @param modifiers_length Number of @a modifiers. |
160 | * @param modifiers Array of modifiers to add. | 160 | * @param modifiers Array of modifiers to add. |
161 | * | 161 | * |
162 | * @return | 162 | * @return #GNUNET_OK on success, #GNUNET_SYSERR on error. |
163 | */ | 163 | */ |
164 | int | 164 | int |
165 | GNUNET_ENV_environment_set_modifiers (const struct GNUNET_ENV_Environment *env, | 165 | GNUNET_ENV_environment_set_modifiers (const struct GNUNET_ENV_Environment *env, |
@@ -192,7 +192,7 @@ GNUNET_ENV_var_get_type (char *name); | |||
192 | * | 192 | * |
193 | * @param size Size of value. | 193 | * @param size Size of value. |
194 | * @param value Raw value of variable. | 194 | * @param value Raw value of variable. |
195 | * @param[out] number Value converted to a 64-bit integer. | 195 | * @param[out] number Value converted to a 64-bit integer. |
196 | * | 196 | * |
197 | * @return #GNUNET_OK on success, #GNUNET_SYSERR if an error occurred (e.g. the value is invalid). | 197 | * @return #GNUNET_OK on success, #GNUNET_SYSERR if an error occurred (e.g. the value is invalid). |
198 | */ | 198 | */ |