refactor: convert to doxygen-style comments #16013

src/nvim/eval/funcs.c

@@ -8520,20 +8520,22 @@ static void f_searchpairpos(typval_T *argvars, typval_T *rettv, FunPtr fptr)
   tv_list_append_number(rettv->vval.v_list, (varnumber_T)col);
 }
 
-/*
+/// Search for a start/middle/end thing.
- * Search for a start/middle/end thing.
+/// Used by searchpair(), see its documentation for the details.
- * Used by searchpair(), see its documentation for the details.
+///
- * Returns 0 or -1 for no match,
+/// @param spat  start pattern
- */
+/// @param mpat  middle pattern
-long do_searchpair(const char *spat,      // start pattern
+/// @param epat  end pattern
-                   const char *mpat,      // middle pattern
+/// @param dir  BACKWARD or FORWARD
-                   const char *epat,      // end pattern
+/// @param skip  skip expression
-                   int dir,               // BACKWARD or FORWARD
+/// @param flags  SP_SETPCMARK and other SP_ values
-                   const typval_T *skip,  // skip expression
+/// @param lnum_stop  stop at this line if not zero
-                   int flags,             // SP_SETPCMARK and other SP_ values
+/// @param time_limit  stop after this many msec
-                   pos_T *match_pos, linenr_T lnum_stop,    // stop at this line if not zero
+///
-                   long time_limit        // stop after this many msec
+/// @returns  0 or -1 for no match,
-                   )
+long do_searchpair(const char *spat, const char *mpat, const char *epat, int dir,
+                   const typval_T *skip, int flags, pos_T *match_pos, linenr_T lnum_stop,
+                   long time_limit)
   FUNC_ATTR_NONNULL_ARG(1, 2, 3)
 {
   char_u *save_cpo;

src/nvim/eval/userfunc.c

@@ -402,15 +402,15 @@ void emsg_funcname(char *ermsg, const char_u *name)
   }
 }
 
-/*
+/// Allocate a variable for the result of a function.
- * Allocate a variable for the result of a function.
+///
- * Return OK or FAIL.
+/// @param name  name of the function
- */
+/// @param len  length of "name" or -1 to use strlen()
-int get_func_tv(const char_u *name,     // name of the function
+/// @param arg  argument, pointing to the '('
-                int len,                // length of "name" or -1 to use strlen()
+/// @param funcexe  various values
-                typval_T *rettv, char_u **arg,           // argument, pointing to the '('
+///
-                funcexe_T *funcexe      // various values
+/// @return  OK or FAIL.
-                )
+int get_func_tv(const char_u *name, int len, typval_T *rettv, char_u **arg, funcexe_T *funcexe)
 {
   char_u *argp;
   int ret = OK;
@@ -1436,17 +1436,18 @@ static void argv_add_base(typval_T *const basetv, typval_T **const argvars, int
 
 /// Call a function with its resolved parameters
 ///
+/// @param funcname  name of the function
+/// @param len  length of "name" or -1 to use strlen()
+/// @param rettv  [out] value goes here
+/// @param argcount_in  number of "argvars"
+/// @param argvars_in  vars for arguments, must have "argcount" PLUS ONE elements!
+/// @param funcexe  more arguments
+///
 /// @return FAIL if function cannot be called, else OK (even if an error
 ///         occurred while executing the function! Set `msg_list` to capture
 ///         the error, see do_cmdline()).
-int call_func(const char_u *funcname,         // name of the function
+int call_func(const char_u *funcname, int len, typval_T *rettv, int argcount_in,
-              int len,                        // length of "name" or -1 to use strlen()
+              typval_T *argvars_in, funcexe_T *funcexe)
-              typval_T *rettv,                // [out] value goes here
-              int argcount_in,                // number of "argvars"
-              typval_T *argvars_in,           // vars for arguments, must have "argcount"
-                                              // PLUS ONE elements!
-              funcexe_T *funcexe              // more arguments
-              )
   FUNC_ATTR_NONNULL_ARG(1, 3, 5, 6)
 {
   int ret = FAIL;
@@ -1690,11 +1691,12 @@ static void list_func_head(ufunc_T *fp, int indent, bool force)
 /// TFN_NO_DEREF:    do not dereference a Funcref
 /// Advances "pp" to just after the function name (if no error).
 ///
+/// @param skip  only find the end, don't evaluate
+/// @param fdp  return: info about dictionary used
+/// @param partial  return: partial of a FuncRef
+///
 /// @return the function name in allocated memory, or NULL for failure.
-char_u *trans_function_name(char_u **pp, bool skip,                     // only find the end, don't evaluate
+char_u *trans_function_name(char_u **pp, bool skip, int flags, funcdict_T *fdp, partial_T **partial)
-                            int flags, funcdict_T *fdp,               // return: info about dictionary used
-                            partial_T **partial            // return: partial of a FuncRef
-                            )
   FUNC_ATTR_NONNULL_ARG(1)
 {
   char_u *name = NULL;