]> git.ipfire.org Git - thirdparty/freeradius-server.git/commitdiff
Doxygen fixes
authorNick Porter <nick@portercomputing.co.uk>
Tue, 2 Sep 2025 09:30:40 +0000 (10:30 +0100)
committerNick Porter <nick@portercomputing.co.uk>
Tue, 2 Sep 2025 09:46:13 +0000 (10:46 +0100)
src/lib/bio/mem.c
src/lib/server/cf_parse.h
src/lib/server/trunk.c
src/lib/unlang/interpret.c
src/lib/util/misc.c
src/lib/util/timer.c
src/modules/rlm_ldap/user.c
src/modules/rlm_winbind/rlm_winbind.c
src/protocols/der/decode.c

index 2d3d71ae2ed6bf723681da11e8f7bc2bfa15acdd..16cb5e8524e69a8aa8f5e1f19089e6a77d207831 100644 (file)
@@ -893,6 +893,7 @@ fr_bio_t *fr_bio_mem_sink_alloc(TALLOC_CTX *ctx, size_t read_size)
  *
  *  @param bio         the binary IO handler
  *  @param verify      the verification function
+ *  @param verify_ctx  to pass to the verification function
  *  @param datagram    whether or not this bio is a datagram one.
  *  @return
  *     - <0 on error
index 2f501b3ddf9e2f0584053e9ef411e91f8dc9d26b..2d3faca2ad2c804ce6936f3b37ecceebd732de75 100644 (file)
@@ -250,7 +250,6 @@ _Generic(&(_ct), \
  *
  * @param[in] _name            of the CONF_PAIR to search for.
  * @param[in] _type            to parse the CONF_PAIR as.
- * @param[in] _flags           controlling parsing behaviour.
  * @param[in] _struct          containing the field to write the result to.
  * @param[in] _field           to write the result to.
  */
@@ -318,7 +317,6 @@ _Generic(&(_ct), \
 
 /** conf_parser_t which populates a sub-struct using a CONF_SECTION
  *
- * @param[in] _name            of the CONF_SECTION to search for.
  * @param[in] _struct          containing the sub-struct to populate.
  * @param[in] _field           containing the sub-struct to populate.
  * @param[in] _subcs           conf_parser_t to include in-line in this section
index f10ff42eed6b391a2bd75dc92eacd403ab59c336..db622a4ce270e235fe83c1e318efcd5102d54cb1 100644 (file)
@@ -4955,6 +4955,7 @@ static int _trunk_free(trunk_t *trunk)
  * @param[in] uctx             User data to pass to the alloc function.
  * @param[in] delay_start      If true, then we will not spawn any connections
  *                             until the first request is enqueued.
+ * @param[in] trigger_args     Pairs to pass to trigger requests, if triggers are enabled.
  * @return
  *     - New trunk handle on success.
  *     - NULL on error.
index 31176546b8798b97cfbadd34fc3dd9b8fc7bce43..c2ebfb2f39ec725ca0cf6606f263023ffffba313 100644 (file)
@@ -440,6 +440,8 @@ static void instruction_retry_handler(UNUSED fr_timer_list_t *tl, UNUSED fr_time
  * @note Sets stack->scratch to be the the result of the frame being popped.
  *
  * @param[in] request                  The current request.
+ * @param[in] frame                    The current stack frame.
+ * @param[in] result                   from the previous action.
  * @return
  *     - UNLANG_FRAME_ACTION_NEXT      evaluate more instructions.
  *     - UNLANG_FRAME_ACTION_POP       the final result has been calculated for this frame.
index a690958294f1f7159bee7fe8c61427865d4d2c61..bf4c82aa58893f3fbc7cf3d98fbf52299fe213e6 100644 (file)
@@ -496,12 +496,12 @@ char const *fr_filename(char const *path)
        return path;
 }
 
-/** Get the filename from a path
+/** Trim a common prefix from a filename
  *
  * @param path to get filename from.
+ * @param common prefix to trim from the path.
  * @return
- *     - pointer to the filename in the path.
- *     - pointer to the path if no '/' is found.
+ *     - pointer to the position on the path where the common prefix match ended.
  */
 char const *fr_filename_common_trim(char const *path, char const *common)
 {
index e537cbdb9f659735242bf41850cee113d3095470..9b07f97f3ca8ffb1a246d181c00e567c78c1150b 100644 (file)
@@ -574,6 +574,7 @@ int _fr_timer_at(NDEBUG_LOCATION_ARGS
  * @param[in,out] ev_p         If not NULL modify this event instead of creating a new one.  This is a parent
  *                             in a temporal sense, not in a memory structure or dependency sense.
  * @param[in] delta            In how many nanoseconds to wait before should we execute the event.
+ * @param[in] free_on_fire     Whether event memory should be freed if the event fires.
  * @param[in] callback         function to execute if the event fires.
  * @param[in] uctx             user data to pass to the event.
  * @return
index 0ab702c904dfa591bd0c4cbc86162e5d2cb50ad0..a8798682e9b58040eda48ece21a4d69ca0c6fb2b 100644 (file)
@@ -148,6 +148,7 @@ static void ldap_find_user_async_cancel(UNUSED request_t *request, UNUSED fr_sig
  * LDAP directory servers out there.
  *
  * @param[in] ctx      in which to allocate the query.
+ * @param[in] p_result Where rcode from running the query will be written.
  * @param[in] inst     rlm_ldap configuration.
  * @param[in] request  Current request.
  * @param[in] base     DN to search in.
index 050edc0a3c1c70f272bc9c18c7fbacdf40a2e6a4..4a6b36b490a9db764f3fdadc2c90977dad3e0589 100644 (file)
@@ -90,6 +90,7 @@ typedef struct {
  * @param request      The current request
  * @param name         Group name to be searched
  * @param env          Group check xlat call_env
+ * @param t            Winbind thread structure
  *
  * @return
  *     - 0 user is in group
index b78657d69bbf8dacf214718f47809060a9e9acac..c2b510659382298b3c1a8b9b17ff860fe48a877b 100644 (file)
@@ -67,6 +67,7 @@ typedef struct {
  * @param[in] parent           Parent attribute.  This should be the root of the dictionary
  *                             we're using to decode DER data initially, and then nested children.
  * @param[in] in               The DER encoded data.
+ * @param[in] allowed_chars    Optional array indicating which ASCII characters are allowed.
  * @param[in] decode_ctx       Any decode specific data.
  * @return
  *     - > 0 on success.  How many bytes were decoded.
@@ -2659,6 +2660,9 @@ static ssize_t fr_der_decode_proto(TALLOC_CTX *ctx, fr_pair_list_t *out, uint8_t
  *                             we're using to decode DER data.  This only specifies structures
  *                             like SEQUENCES.  OID based pairs are resolved using the global
  *                             dictionary tree.
+ * @param[in] data             to decode.
+ * @param[in] data_len         Length of data.
+ * @param[in] decode_ctx       to pass to decode function.
  *
  */
 static ssize_t decode_pair(TALLOC_CTX *ctx, fr_pair_list_t *out, fr_dict_attr_t const *parent, uint8_t const *data,