Skip to content
Snippets Groups Projects
Commit 291e95be authored by Daniel Salzman's avatar Daniel Salzman
Browse files

conf: unify Doxygen comments

parent 312109ec
No related branches found
No related tags found
No related merge requests found
Hide whitespace changes
Inline Side-by-side
src/knot/conf/base.h
+ 26
− 26
View file @ 291e95be
......@@ -84,9 +84,9 @@ conf_t* conf(void);
/*!
* Creates new or opens old configuration database.
*
* \param[out] conf Configuration.
* \param[in] scheme Configuration scheme.
* \param[in] db_dir Database path or NULL.
* \param[out] conf Configuration.
* \param[in] scheme Configuration scheme.
* \param[in] db_dir Database path or NULL.
*
* \return Error code, KNOT_EOK if success.
*/
......@@ -101,7 +101,7 @@ int conf_new(
*
* Shared objects: api, mm, db, filename.
*
* \param[out] conf Configuration.
* \param[out] conf Configuration.
*
* \return Error code, KNOT_EOK if success.
*/
......@@ -112,7 +112,7 @@ int conf_clone(
/*!
* Processes some additional operations and checks after configuration loading.
*
* \param[in] conf Configuration.
* \param[in] conf Configuration.
*
* \return Error code, KNOT_EOK if success.
*/
......@@ -123,7 +123,7 @@ int conf_post_open(
/*!
* Replaces the active configuration with the specified one.
*
* \param[in] conf New configuration.
* \param[in] conf New configuration.
*/
void conf_update(
conf_t *conf
......@@ -132,8 +132,8 @@ void conf_update(
/*!
* Removes the specified configuration.
*
* \param[in] conf Configuration.
* \param[in] is_clone Specifies if the configuration is a clone.
* \param[in] conf Configuration.
* \param[in] is_clone Specifies if the configuration is a clone.
*/
void conf_free(
conf_t *conf,
......@@ -143,10 +143,10 @@ void conf_free(
/*!
* Activates configured query modules for the specified zone or for all zones.
*
* \param[in] conf Configuration.
* \param[in] zone_name Zone name, NULL for all zones.
* \param[in] query_modules Destination query modules list.
* \param[in] query_plan Destination query plan.
* \param[in] conf Configuration.
* \param[in] zone_name Zone name, NULL for all zones.
* \param[in] query_modules Destination query modules list.
* \param[in] query_plan Destination query plan.
*/
void conf_activate_modules(
conf_t *conf,
......@@ -158,9 +158,9 @@ void conf_activate_modules(
/*!
* Deactivates query modules list.
*
* \param[in] conf Configuration.
* \param[in] query_modules Destination query modules list.
* \param[in] query_plan Destination query plan.
* \param[in] conf Configuration.
* \param[in] query_modules Destination query modules list.
* \param[in] query_plan Destination query plan.
*/
void conf_deactivate_modules(
conf_t *conf,
......@@ -173,11 +173,11 @@ void conf_deactivate_modules(
*
* This function is not for direct using, just for includes processing!
*
* \param[in] conf Configuration.
* \param[in] txn Transaction.
* \param[in] input Configuration string or filename.
* \param[in] is_file Specifies if the input is string or input filename.
* \param[in] data Internal data.
* \param[in] conf Configuration.
* \param[in] txn Transaction.
* \param[in] input Configuration string or filename.
* \param[in] is_file Specifies if the input is string or input filename.
* \param[in] data Internal data.
*
* \return Error code, KNOT_EOK if success.
*/
......@@ -192,9 +192,9 @@ int conf_parse(
/*!
* Imports textual configuration.
*
* \param[in] conf Configuration.
* \param[in] input Configuration string or input filename.
* \param[in] is_file Specifies if the input is string or filename.
* \param[in] conf Configuration.
* \param[in] input Configuration string or input filename.
* \param[in] is_file Specifies if the input is string or filename.
*
* \return Error code, KNOT_EOK if success.
*/
......@@ -207,9 +207,9 @@ int conf_import(
/*!
* Exports configuration to textual file.
*
* \param[in] conf Configuration.
* \param[in] input Output filename.
* \param[in] style Formatting style.
* \param[in] conf Configuration.
* \param[in] input Output filename.
* \param[in] style Formatting style.
*
* \return Error code, KNOT_EOK if success.
*/
......
src/knot/conf/conf.h
+ 89
− 89
View file @ 291e95be
......@@ -83,12 +83,12 @@ typedef struct {
} conf_mod_id_t;
/*!
* Gets a configuration item value of a section without identifiers.
* Gets the configuration item value of the section without identifiers.
*
* \param[in] conf Configuration.
* \param[in] txn Confuration DB transaction.
* \param[in] key0_name Section name.
* \param[in] key1_name Item name.
* \param[in] conf Configuration.
* \param[in] txn Configuration DB transaction.
* \param[in] key0_name Section name.
* \param[in] key1_name Item name.
*
* \return Item value.
*/
......@@ -107,14 +107,14 @@ static inline conf_val_t conf_get(
}
/*!
* Gets a configuration item value of a section with identifiers (raw version).
* Gets the configuration item value of the section with identifiers (raw version).
*
* \param[in] conf Configuration.
* \param[in] txn Confuration DB transaction.
* \param[in] key0_name Section name.
* \param[in] key1_name Item name.
* \param[in] id Section identifier (raw value).
* \param[in] id_len Length of the section identifier.
* \param[in] conf Configuration.
* \param[in] txn Configuration DB transaction.
* \param[in] key0_name Section name.
* \param[in] key1_name Item name.
* \param[in] id Section identifier (raw value).
* \param[in] id_len Length of the section identifier.
*
* \return Item value.
*/
......@@ -138,13 +138,13 @@ static inline conf_val_t conf_rawid_get(
}
/*!
* Gets a configuration item value of a section with identifiers.
* Gets the configuration item value of the section with identifiers.
*
* \param[in] conf Configuration.
* \param[in] txn Confuration DB transaction.
* \param[in] key0_name Section name.
* \param[in] key1_name Item name.
* \param[in] id Section identifier (output of a config getter).
* \param[in] conf Configuration.
* \param[in] txn Configuration DB transaction.
* \param[in] key0_name Section name.
* \param[in] key1_name Item name.
* \param[in] id Section identifier (output of a config getter).
*
* \return Item value.
*/
......@@ -165,12 +165,12 @@ static inline conf_val_t conf_id_get(
}
/*!
* Gets a configuration item value of a module section.
* Gets the configuration item value of the module section.
*
* \param[in] conf Configuration.
* \param[in] txn Confuration DB transaction.
* \param[in] key1_name Item name.
* \param[in] mod_id Module identifier.
* \param[in] conf Configuration.
* \param[in] txn Configuration DB transaction.
* \param[in] key1_name Item name.
* \param[in] mod_id Module identifier.
*
* \return Item value.
*/
......@@ -189,14 +189,14 @@ static inline conf_val_t conf_mod_get(
}
/*!
* Gets a configuration item value of a zone section.
* Gets the configuration item value of the zone section.
*
* \note A possibly associated template is taken into account.
*
* \param[in] conf Configuration.
* \param[in] txn Confuration DB transaction.
* \param[in] key1_name Item name.
* \param[in] dname Zone name.
* \param[in] conf Configuration.
* \param[in] txn Configuration DB transaction.
* \param[in] key1_name Item name.
* \param[in] dname Zone name.
*
* \return Item value.
*/
......@@ -215,11 +215,11 @@ static inline conf_val_t conf_zone_get(
}
/*!
* Gets a configuration item value of the default template.
* Gets the configuration item value of the default template.
*
* \param[in] conf Configuration.
* \param[in] txn Confuration DB transaction.
* \param[in] key1_name Item name.
* \param[in] conf Configuration.
* \param[in] txn Configuration DB transaction.
* \param[in] key1_name Item name.
*
* \return Item value.
*/
......@@ -238,9 +238,9 @@ static inline conf_val_t conf_default_get(
/*!
* Gets the number of section identifiers.
*
* \param[in] conf Configuration.
* \param[in] txn Confuration DB transaction.
* \param[in] key0_name Section name.
* \param[in] conf Configuration.
* \param[in] txn Configuration DB transaction.
* \param[in] key0_name Section name.
*
* \return Number of identifiers.
*/
......@@ -259,9 +259,9 @@ static inline size_t conf_id_count(
/*!
* Gets a configuration section iterator.
*
* \param[in] conf Configuration.
* \param[in] txn Confuration DB transaction.
* \param[in] key0_name Section name.
* \param[in] conf Configuration.
* \param[in] txn Configuration DB transaction.
* \param[in] key0_name Section name.
*
* \return Section iterator.
*/
......@@ -280,8 +280,8 @@ static inline conf_iter_t conf_iter(
/*!
* Moves the configuration section iterator to the next identifier.
*
* \param[in] conf Configuration.
* \param[in] iter Configuration iterator.
* \param[in] conf Configuration.
* \param[in] iter Configuration iterator.
*/
void conf_iter_next(
conf_t *conf,
......@@ -291,8 +291,8 @@ void conf_iter_next(
/*!
* Gets the current iterator value (identifier).
*
* \param[in] conf Configuration.
* \param[in] iter Configuration iterator.
* \param[in] conf Configuration.
* \param[in] iter Configuration iterator.
*
* \return Section identifier.
*/
......@@ -302,10 +302,10 @@ conf_val_t conf_iter_id(
);
/*!
* Deletes a section iterator.
* Deletes the section iterator.
*
* \param[in] conf Configuration.
* \param[in] iter Configuration iterator.
* \param[in] conf Configuration.
* \param[in] iter Configuration iterator.
*/
void conf_iter_finish(
conf_t *conf,
......@@ -317,7 +317,7 @@ void conf_iter_finish(
*
* The following access is through val->len and val->data.
*
* \param[in] val Item value.
* \param[in] val Item value.
*/
void conf_val(
conf_val_t *val
......@@ -326,7 +326,7 @@ void conf_val(
/*!
* Moves to the next item value.
*
* \param[in] val Item value.
* \param[in] val Item value.
*/
void conf_val_next(
conf_val_t *val
......@@ -335,7 +335,7 @@ void conf_val_next(
/*!
* Gets the number of values if multivalued item.
*
* \param[in] val Item value.
* \param[in] val Item value.
*
* \return Number of values.
*/
......@@ -346,8 +346,8 @@ size_t conf_val_count(
/*!
* Checks if two item values are equal.
*
* \param[in] val1 First item value.
* \param[in] val2 Second item value.
* \param[in] val1 First item value.
* \param[in] val2 Second item value.
*
* \return true if equal, false if not.
*/
......@@ -359,7 +359,7 @@ bool conf_val_equal(
/*!
* Gets the numeric value of the item.
*
* \param[in] val Item value.
* \param[in] val Item value.
*
* \return Integer.
*/
......@@ -370,7 +370,7 @@ int64_t conf_int(
/*!
* Gets the boolean value of the item.
*
* \param[in] val Item value.
* \param[in] val Item value.
*
* \return Boolean.
*/
......@@ -381,7 +381,7 @@ bool conf_bool(
/*!
* Gets the option value of the item.
*
* \param[in] val Item value.
* \param[in] val Item value.
*
* \return Option id.
*/
......@@ -392,7 +392,7 @@ unsigned conf_opt(
/*!
* Gets the string value of the item.
*
* \param[in] val Item value.
* \param[in] val Item value.
*
* \return String pointer.
*/
......@@ -403,7 +403,7 @@ const char* conf_str(
/*!
* Gets the dname value of the item.
*
* \param[in] val Item value.
* \param[in] val Item value.
*
* \return Dname pointer.
*/
......@@ -414,8 +414,8 @@ const knot_dname_t* conf_dname(
/*!
* Gets the length-prefixed data value of the item.
*
* \param[in] val Item value.
* \param[out] len Output length.
* \param[in] val Item value.
* \param[out] len Output length.
*
* \return Data pointer.
*/
......@@ -427,8 +427,8 @@ const uint8_t* conf_bin(
/*!
* Gets the generic data value of the item.
*
* \param[in] val Item value.
* \param[out] len Output length.
* \param[in] val Item value.
* \param[out] len Output length.
*
* \return Data pointer.
*/
......@@ -440,8 +440,8 @@ const uint8_t* conf_data(
/*!
* Gets the socket address value of the item.
*
* \param[in] val Item value.
* \param[in] sock_base_dir Path prefix for a relative UNIX socket location.
* \param[in] val Item value.
* \param[in] sock_base_dir Path prefix for a relative UNIX socket location.
*
* \return Socket address.
*/
......@@ -453,9 +453,9 @@ struct sockaddr_storage conf_addr(
/*!
* Gets the socket address range value of the item.
*
* \param[in] val Item value.
* \param[out] max_ss Upper address bound or AF_UNSPEC family if not specified.
* \param[out] prefix_len Network subnet prefix length or -1 if not specified.
* \param[in] val Item value.
* \param[out] max_ss Upper address bound or AF_UNSPEC family if not specified.
* \param[out] prefix_len Network subnet prefix length or -1 if not specified.
*
* \return Socket address.
*/
......@@ -470,8 +470,8 @@ struct sockaddr_storage conf_addr_range(
*
* \note The result must be explicitly deallocated.
*
* \param[in] val Item value.
* \param[in] sock_base_dir Path prefix for a relative string.
* \param[in] val Item value.
* \param[in] sock_base_dir Path prefix for a relative string.
*
* \return Absolute path string pointer.
*/
......@@ -483,7 +483,7 @@ char* conf_abs_path(
/*!
* Gets the module identifier value of the item.
*
* \param[in] val Item value.
* \param[in] val Item value.
*
* \return Module identifier.
*/
......@@ -492,9 +492,9 @@ conf_mod_id_t* conf_mod_id(
);
/*!
* Destroys a module identifier.
* Destroys the module identifier.
*
* \param[in] mod_id Module identifier.
* \param[in] mod_id Module identifier.
*/
void conf_free_mod_id(
conf_mod_id_t *mod_id
......@@ -505,9 +505,9 @@ void conf_free_mod_id(
*
* \note The result must be explicitly deallocated.
*
* \param[in] conf Configuration.
* \param[in] txn Confuration DB transaction.
* \param[in] zone Zone name.
* \param[in] conf Configuration.
* \param[in] txn Configuration DB transaction.
* \param[in] zone Zone name.
*
* \return Absolute zonef ile path string pointer.
*/
......@@ -528,9 +528,9 @@ static inline char* conf_zonefile(
*
* \note The result must be explicitly deallocated.
*
* \param[in] conf Configuration.
* \param[in] txn Confuration DB transaction.
* \param[in] zone Zone name.
* \param[in] conf Configuration.
* \param[in] txn Configuration DB transaction.
* \param[in] zone Zone name.
*
* \return Absolute journal file path string pointer.
*/
......@@ -549,8 +549,8 @@ static inline char* conf_journalfile(
/*!
* Gets the configured number of UDP threads.
*
* \param[in] conf Configuration.
* \param[in] txn Confuration DB transaction.
* \param[in] conf Configuration.
* \param[in] txn Configuration DB transaction.
*
* \return Number of threads.
*/
......@@ -567,8 +567,8 @@ static inline size_t conf_udp_threads(
/*!
* Gets the configured number of TCP threads.
*
* \param[in] conf Configuration.
* \param[in] txn Confuration DB transaction.
* \param[in] conf Configuration.
* \param[in] txn Configuration DB transaction.
*
* \return Number of threads.
*/
......@@ -585,8 +585,8 @@ static inline size_t conf_tcp_threads(
/*!
* Gets the configured number of worker threads.
*
* \param[in] conf Configuration.
* \param[in] txn Confuration DB transaction.
* \param[in] conf Configuration.
* \param[in] txn Configuration DB transaction.
*
* \return Number of threads.
*/
......@@ -603,10 +603,10 @@ static inline size_t conf_bg_threads(
/*!
* Gets the configured user and group identifiers.
*
* \param[in] conf Configuration.
* \param[in] txn Confuration DB transaction.
* \param[out] uid User identifier.
* \param[out] gid Group identifier.
* \param[in] conf Configuration.
* \param[in] txn Configuration DB transaction.
* \param[out] uid User identifier.
* \param[out] gid Group identifier.
*
* \return Knot error code.
*/
......@@ -627,10 +627,10 @@ static inline int conf_user(
/*!
* Gets the remote parameters for the given identifier.
*
* \param[in] conf Configuration.
* \param[in] txn Confuration DB transaction.
* \param[in] id Remote identifier.
* \param[in] index Remote index.
* \param[in] conf Configuration.
* \param[in] txn Configuration DB transaction.
* \param[in] id Remote identifier.
* \param[in] index Remote index.
*
* \return Remote parameters.
*/
......
src/knot/conf/confdb.c
+ 34
− 0
View file @ 291e95be
......@@ -29,6 +29,40 @@
#include "libknot/errcode.h"
#include "libknot/yparser/yptrafo.h"
/*
* A simple configuration:
*
* server.identity: "knot"
* server.version: "version"
* template[tpl1].storage: "directory1"
* template[tpl2].storage: "directory2"
* template[tpl2].master: [ "master1", "master2" ]
*
* And the corresponding configuration DB content:
*
* # DB structure version.
* [00][FF]: [02]
* # Sections codes.
* [00][00]server: [02]
* [00][00]template: [03]
* # Server section items codes.
* [02][00]identity: [02]
* [02][00]version: [03]
* # Server items values.
* [02][02]: knot\0
* [02][03]: version\0
* # Template section items codes.
* [03][00]master: [03]
* [03][00]storage: [02]
* # Template identificators.
* [03][01]tpl1\0
* [03][01]tpl2\0
* # Template items values.
* [03][02]tpl1\0: directory1\0
* [03][02]tpl2\0: directory2\0
* [03][03]tpl2\0: [00][08]master1\0 [00][08]master2\0
*/
typedef enum {
KEY0_ROOT = 0,
KEY1_ITEMS = 0,
......
src/knot/conf/confdb.h
+ 111
− 0
View file @ 291e95be
......@@ -41,11 +41,37 @@
/*! Maximum size of database data. */
#define CONF_MAX_DATA_LEN 65536
/*!
* Opens and checks old or initializes new configuration DB.
*
* \param[in] conf Configuration.
* \param[in] txn Configuration DB transaction.
*
* \return Error code, KNOT_EOK if success.
*/
int conf_db_init(
conf_t *conf,
namedb_txn_t *txn
);
/*!
* Sets the item with data in the configuration DB.
*
* Singlevalued data is rewritten, multivalued data is appended.
*
* \note Setting of key0 without key1 has no effect.
*
* \param[in] conf Configuration.
* \param[in] txn Configuration DB transaction.
* \param[in] key0 Section name.
* \param[in] key1 Item name.
* \param[in] id Section identifier.
* \param[in] id_len Length of the section identifier.
* \param[in] data Item data.
* \param[in] data_len Length of the item data.
*
* \return Error code, KNOT_EOK if success.
*/
int conf_db_set(
conf_t *conf,
namedb_txn_t *txn,
......@@ -57,6 +83,23 @@ int conf_db_set(
size_t data_len
);
/*!
* Unsets the item data in the configuration DB.
*
* If no data is provided, the whole item is remove.
*
* \param[in] conf Configuration.
* \param[in] txn Configuration DB transaction.
* \param[in] key0 Section name.
* \param[in] key1 Item name.
* \param[in] id Section identifier.
* \param[in] id_len Length of the section identifier.
* \param[in] data Item data.
* \param[in] data_len Length of the item data.
* \param[in] delete_key1 Set to unregister the item from the DB.
*
* \return Error code, KNOT_EOK if success.
*/
int conf_db_unset(
conf_t *conf,
namedb_txn_t *txn,
......@@ -69,6 +112,19 @@ int conf_db_unset(
bool delete_key1
);
/*!
* Gets the item data from the configuration DB.
*
* \param[in] conf Configuration.
* \param[in] txn Configuration DB transaction.
* \param[in] key0 Section name.
* \param[in] key1 Item name.
* \param[in] id Section identifier.
* \param[in] id_len Length of the section identifier.
* \param[out] data Item data.
*
* \return Error code, KNOT_EOK if success.
*/
int conf_db_get(
conf_t *conf,
namedb_txn_t *txn,
......@@ -79,6 +135,16 @@ int conf_db_get(
conf_val_t *data
);
/*!
* Gets a configuration DB section iterator.
*
* \param[in] conf Configuration.
* \param[in] txn Configuration DB transaction.
* \param[in] key0 Section name.
* \param[out] iter Section iterator.
*
* \return Error code, KNOT_EOK if success.
*/
int conf_db_iter_begin(
conf_t *conf,
namedb_txn_t *txn,
......@@ -86,11 +152,29 @@ int conf_db_iter_begin(
conf_iter_t *iter
);
/*!
* Moves the section iterator to the next identifier.
*
* \param[in] conf Configuration.
* \param[in,out] iter Section iterator.
*
* \return Error code, KNOT_EOK if success.
*/
int conf_db_iter_next(
conf_t *conf,
conf_iter_t *iter
);
/*!
* Gets the current section iterator value (identifier).
*
* \param[in] conf Configuration.
* \param[in] iter Section iterator.
* \param[out] data Identifier.
* \param[out] data_len Length of the identifier.
*
* \return Error code, KNOT_EOK if success.
*/
int conf_db_iter_id(
conf_t *conf,
conf_iter_t *iter,
......@@ -98,18 +182,45 @@ int conf_db_iter_id(
size_t *data_len
);
/*!
* Deletes the current section iterator value (identifier).
*
* \param[in] conf Configuration.
* \param[in,out] iter Section iterator.
*
* \return Error code, KNOT_EOK if success.
*/
int conf_db_iter_del(
conf_t *conf,
conf_iter_t *iter
);
/*!
* Deletes the section iterator.
*
* \param[in] conf Configuration.
* \param[in,out] iter Section iterator.
*/
void conf_db_iter_finish(
conf_t *conf,
conf_iter_t *iter
);
/*!
* Dumps the configuration DB in the textual form.
*
* \note This function is intended for debugging.
*
* \param[in] conf Configuration.
* \param[in] txn Configuration DB transaction.
* \param[in] file_name File name to dump to (NULL to dump to stdout).
*
* \return Error code, KNOT_EOK if success.
*/
int conf_db_raw_dump(
conf_t *conf,
namedb_txn_t *txn,
const char *file_name
);
/*! @} */
src/knot/conf/confio.h
+ 25
− 25
View file @ 291e95be
......@@ -77,7 +77,7 @@ struct conf_io {
/*!
* Starts new writing transaction.
*
* \param[in] child Nested transaction indicator.
* \param[in] child Nested transaction indicator.
*
* \return Error code, KNOT_EOK if success.
*/
......@@ -88,7 +88,7 @@ int conf_io_begin(
/*!
* Commits the current writing transaction.
*
* \param[in] child Nested transaction indicator.
* \param[in] child Nested transaction indicator.
*
* \return Error code, KNOT_EOK if success.
*/
......@@ -99,7 +99,7 @@ int conf_io_commit(
/*!
* Aborts the current writing transaction.
*
* \param[in] child Nested transaction indicator.
* \param[in] child Nested transaction indicator.
*
* \return Error code, KNOT_EOK if success.
*/
......@@ -110,8 +110,8 @@ int conf_io_abort(
/*!
* Gets the configuration group item subsection list.
*
* \param[in] key0 Section name (NULL to get section list).
* \param[out] io Operation output.
* \param[in] key0 Section name (NULL to get section list).
* \param[out] io Operation output.
*
* \return Error code, KNOT_EOK if success.
*/
......@@ -124,10 +124,10 @@ int conf_io_desc(
* Gets the configuration difference between the current configuration and
* the active transaction.
*
* \param[in] key0 Section name (NULL to diff all sections).
* \param[in] key1 Item name (NULL to diff all section items).
* \param[in] id Section identifier name (NULL to consider all section identifiers).
* \param[out] io Operation output.
* \param[in] key0 Section name (NULL to diff all sections).
* \param[in] key1 Item name (NULL to diff all section items).
* \param[in] id Section identifier name (NULL to consider all section identifiers).
* \param[out] io Operation output.
*
* \return Error code, KNOT_EOK if success.
*/
......@@ -141,11 +141,11 @@ int conf_io_diff(
/*!
* Gets the configuration item(s) value(s).
*
* \param[in] key0 Section name (NULL to get all sections).
* \param[in] key1 Item name (NULL to get all section items).
* \param[in] id Section identifier name (NULL to consider all section identifiers).
* \param[in] key0 Section name (NULL to get all sections).
* \param[in] key1 Item name (NULL to get all section items).
* \param[in] id Section identifier name (NULL to consider all section identifiers).
* \param[in] get_current The current configuration or the active transaction switch.
* \param[out] io Operation output.
* \param[out] io Operation output.
*
* \return Error code, KNOT_EOK if success.
*/
......@@ -160,11 +160,11 @@ int conf_io_get(
/*!
* Sets the configuration item(s) value.
*
* \param[in] key0 Section name.
* \param[in] key1 Item name (NULL to add identifier only).
* \param[in] id Section identifier name (NULL to consider all section identifiers).
* \param[in] data Item data to set/add.
* \param[out] io Operation output (callback error output).
* \param[in] key0 Section name.
* \param[in] key1 Item name (NULL to add identifier only).
* \param[in] id Section identifier name (NULL to consider all section identifiers).
* \param[in] data Item data to set/add.
* \param[out] io Operation output (callback error output).
*
* \return Error code, KNOT_EOK if success.
*/
......@@ -179,10 +179,10 @@ int conf_io_set(
/*!
* Unsets the configuration item(s) value(s).
*
* \param[in] key0 Section name (NULL to unset all sections).
* \param[in] key1 Item name (NULL to unset the whole section).
* \param[in] id Section identifier name (NULL to consider all section identifiers).
* \param[in] data Item data (NULL to unset all data).
* \param[in] key0 Section name (NULL to unset all sections).
* \param[in] key1 Item name (NULL to unset the whole section).
* \param[in] id Section identifier name (NULL to consider all section identifiers).
* \param[in] data Item data (NULL to unset all data).
*
* \return Error code, KNOT_EOK if success.
*/
......@@ -196,7 +196,7 @@ int conf_io_unset(
/*!
* Checks the configuration database semantics in the current writing transaction.
*
* \param[out] io Operation output.
* \param[out] io Operation output.
*
* \return Error code, KNOT_EOK if success.
*/
......@@ -209,7 +209,7 @@ int conf_io_check(
*
* \note The result must be deallocated.
*
* \param[out] io Operation output.
* \param[out] io Operation output.
*
* \return String or NULL.
*/
......@@ -222,7 +222,7 @@ char *conf_io_txt_key(
*
* \note The result must be deallocated.
*
* \param[out] io Operation output.
* \param[out] io Operation output.
*
* \return String or NULL.
*/
......
src/knot/conf/scheme.h
+ 2
− 0
View file @ 291e95be
......@@ -92,3 +92,5 @@ enum {
extern const lookup_table_t acl_actions[];
extern const yp_item_t conf_scheme[];
/*! @} */
src/knot/conf/tools.h
+ 2
− 0
View file @ 291e95be
......@@ -96,3 +96,5 @@ int check_zone(
int include_file(
conf_check_t *args
);
/*! @} */
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment