Commit b46d25fe authored by Marek Vavruša's avatar Marek Vavruša

lib: doxygen groups

parent d1fcd8f8
......@@ -14,6 +14,9 @@
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
/** \addtogroup cache
* @{
*/
#pragma once
#include <libknot/rrset.h>
......@@ -120,3 +123,4 @@ int kr_cache_clear(namedb_txn_t *txn);
*/
int kr_cache_prune(namedb_txn_t *txn, uint32_t timestamp);
/** @} */
......@@ -22,6 +22,10 @@
#include "lib/module.h"
#include "lib/cache.h"
/** \addtogroup resolution
* @{
*/
/**
* Name resolution context.
*
......@@ -62,3 +66,5 @@ int kr_context_deinit(struct kr_context *ctx);
* @return KNOT_E*
*/
int kr_context_register(struct kr_context *ctx, const char *module_name);
/** @} */
......@@ -14,6 +14,10 @@
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
/** \addtogroup resolution
* @{
*/
#pragma once
#include <errno.h>
......@@ -44,4 +48,6 @@
#define KR_DNS_PORT 53
#define KR_DNAME_ROOT ((const knot_dname_t*)"")
#define KR_EDNS_VERSION 0
#define KR_EDNS_PAYLOAD 4096
\ No newline at end of file
#define KR_EDNS_PAYLOAD 4096
/** @} */
......@@ -16,6 +16,10 @@
#pragma once
/** \addtogroup modules
* @{
*/
#include <libknot/processing/layer.h>
#include <libknot/packet/pkt.h>
......@@ -44,3 +48,4 @@ struct kr_layer_param {
#define QRDEBUG(query, cls, fmt, ...)
#endif
/** @} */
......@@ -14,6 +14,10 @@
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
/** \addtogroup modules
* @{
*/
#pragma once
#include <libknot/processing/layer.h>
......@@ -87,3 +91,5 @@ void kr_module_unload(struct kr_module *module);
*/
#define KR_MODULE_EXPORT(module) \
uint32_t module ## _api() { return KR_MODULE_API; }
/** @} */
......@@ -14,6 +14,10 @@
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
/** \addtogroup nameservers
* @{
*/
#pragma once
#include "lib/layer.h"
......@@ -28,4 +32,6 @@ enum kr_ns_score {
* @param param layer parameters
* @return enum kr_ns_score or higher positive value
*/
int kr_nsrep_score(const knot_dname_t *ns, struct kr_layer_param *param);
\ No newline at end of file
int kr_nsrep_score(const knot_dname_t *ns, struct kr_layer_param *param);
/** @} */
......@@ -14,6 +14,10 @@
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
/** \addtogroup resolution
* @{
*/
#pragma once
#include <libknot/packet/pkt.h>
......@@ -31,3 +35,5 @@
*/
int kr_resolve(struct kr_context* ctx, knot_pkt_t *answer,
const knot_dname_t *qname, uint16_t qclass, uint16_t qtype);
/** @} */
......@@ -14,6 +14,10 @@
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
/** \addtogroup rplan
* @{
*/
#pragma once
#include <sys/time.h>
......@@ -135,3 +139,5 @@ struct kr_query *kr_rplan_current(struct kr_rplan *rplan);
* Return true if resolution chain satisfies given query.
*/
bool kr_rplan_satisfies(struct kr_query *closure, const knot_dname_t *name, uint16_t cls, uint16_t type);
/** @} */
......@@ -14,6 +14,10 @@
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
/** \addtogroup utils
* @{
*/
#pragma once
#include <stdio.h>
......@@ -35,3 +39,5 @@ extern void _cleanup_fclose(FILE **p);
/** Concatenate N strings. */
char* kr_strcatdup(unsigned n, ...);
/** @} */
......@@ -14,6 +14,10 @@
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
/** \addtogroup rplan
* @{
*/
#pragma once
#include <libknot/dname.h>
......@@ -68,3 +72,4 @@ int kr_set_zone_cut_addr(struct kr_zonecut *cut, const knot_rrset_t *rr, uint16_
*/
int kr_find_zone_cut(struct kr_zonecut *cut, const knot_dname_t *name, namedb_txn_t *txn, uint32_t timestamp);
/** @} */
Markdown is supported
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