]> git.ipfire.org Git - thirdparty/freeradius-server.git/commitdiff
Add documentation sections
authorArran Cudbard-Bell <a.cudbardb@freeradius.org>
Sat, 25 Nov 2023 23:42:44 +0000 (17:42 -0600)
committerArran Cudbard-Bell <a.cudbardb@freeradius.org>
Sat, 25 Nov 2023 23:43:00 +0000 (17:43 -0600)
src/lib/unlang/call_env.h

index a945374f752ef68aa0960d955398521c9a79dd0a..894ef8cc34e53ba161d2dec4ae4c81b0740eb58f 100644 (file)
@@ -380,8 +380,15 @@ typedef void _mismatch_flags;              //!< Dummy type used to indicate bad flags.
                .func = _func \
        }
 
+/** @name Expand a call_env_t
+ * @{
+ */
 unlang_action_t call_env_expand(TALLOC_CTX *ctx, request_t *request, call_env_result_t *result, void **env_data, call_env_t const *call_env);
+/** @} */
 
+/** @name Functions to be used by the section callbacks to add parsed data.
+ * @{
+ */
 call_env_parsed_t *call_env_parsed_add(TALLOC_CTX *ctx, call_env_parsed_head_t *head, call_env_parser_t const *rule);
 
 void call_env_parsed_set_tmpl(call_env_parsed_t *parsed, tmpl_t const *tmpl);
@@ -393,9 +400,14 @@ void call_env_parsed_set_data(call_env_parsed_t *parsed, void const *data);
 void call_env_parsed_set_multi_index(call_env_parsed_t *parsed, size_t count, size_t index);
 
 void call_env_parsed_free(call_env_parsed_head_t *parsed, call_env_parsed_t *ptr);
+/** @} */
 
+/** @name Allocate a new call env
+ * @{
+ */
 call_env_t *call_env_alloc(TALLOC_CTX *ctx, char const *name, call_env_method_t const *call_env_method,
                           fr_dict_t const *namespace, CONF_SECTION *cs) CC_HINT(nonnull(3,4,5));
+/** @} */
 
 #ifdef __cplusplus
 }