aboutsummaryrefslogtreecommitdiff
path: root/include/magi/param.h
diff options
context:
space:
mode:
Diffstat (limited to 'include/magi/param.h')
-rw-r--r--include/magi/param.h19
1 files changed, 9 insertions, 10 deletions
diff --git a/include/magi/param.h b/include/magi/param.h
index 7e1262b..0ad1919 100644
--- a/include/magi/param.h
+++ b/include/magi/param.h
@@ -5,34 +5,33 @@
*/
-/** @brief Parameter as name-value pair. */
+/** Parameter as name-value pair. */
typedef struct magi_param {
- char *name; /**<@brief Cannot be null. */
- char *data; /**<@brief Cannot be null. */
+ char *name; /**< Cannot be null. */
+ char *data; /**< Cannot be null. */
} magi_param;
-/** @brief Parameters collection.
- *
+/** Parameters collection.
* Implemented as a linked list. */
typedef struct magi_params {
- struct magi_params *next; /**<@brief Pointer to next parameters. */
- magi_param item; /**<@brief Parameter on top. */
+ struct magi_params *next; /**< Pointer to next parameters. */
+ magi_param item; /**< Parameter on top. */
} magi_params;
-/** @brief Add @p newitem to @p params.
+/** Add @p newitem to @p params.
* @param[in,out] params to add into.
* @param[in] newitem to add onto top of @p params. */
void magi_params_add(magi_params **params, magi_param *newitem);
-/** @brief Get data of parameter from @p params with @p name.
+/** Get data of parameter from @p params with @p name.
* @param[in] params to search in.
* @param[in] name of needed parameter.
* @return data of the first from top of @p params parameter with @p name,
* null only if no such parameter. */
char *magi_params_get(magi_params *params, const char *name);
-/** @brief Free memory used by @p params.
+/** Free memory used by @p params.
* @param[in,out] params to be destructed. */
void magi_params_free(magi_params *params);