doxygen: add prefix for groups (#9991)
Some checks failed
pkgs_test / change (push) Has been skipped
AutoTestCI / components/cpp11 (push) Has been cancelled
AutoTestCI / kernel/atomic (push) Has been cancelled
AutoTestCI / kernel/atomic/riscv64 (push) Has been cancelled
AutoTestCI / kernel/atomic_c11 (push) Has been cancelled
AutoTestCI / kernel/atomic_c11/riscv64 (push) Has been cancelled
AutoTestCI / kernel/device (push) Has been cancelled
AutoTestCI / kernel/ipc (push) Has been cancelled
AutoTestCI / kernel/irq (push) Has been cancelled
AutoTestCI / kernel/mem (push) Has been cancelled
AutoTestCI / kernel/mem/riscv64 (push) Has been cancelled
AutoTestCI / kernel/thread (push) Has been cancelled
AutoTestCI / kernel/timer (push) Has been cancelled
AutoTestCI / rtsmart/aarch64 (push) Has been cancelled
AutoTestCI / rtsmart/arm (push) Has been cancelled
AutoTestCI / rtsmart/riscv64 (push) Has been cancelled
AutoTestCI / components/utest (push) Has been cancelled
RT-Thread BSP Static Build Check / ESP32C3 (push) Has been cancelled
RT-Thread BSP Static Build Check / Infineon_TI_microchip (push) Has been cancelled
RT-Thread BSP Static Build Check / RT-Thread Online Packages (STM32F407 RT-Spark) (push) Has been cancelled
RT-Thread BSP Static Build Check / RTduino/Arduino Libraries (Raspberry Pico) (push) Has been cancelled
RT-Thread BSP Static Build Check / RTduino/Arduino Libraries (STM32F412 Nucleo) (push) Has been cancelled
RT-Thread BSP Static Build Check / aarch64 (push) Has been cancelled
RT-Thread BSP Static Build Check / gd32_n32_apm32 (push) Has been cancelled
RT-Thread BSP Static Build Check / hpmicro (push) Has been cancelled
RT-Thread BSP Static Build Check / i386-unknown (push) Has been cancelled
RT-Thread BSP Static Build Check / llvm-arm (push) Has been cancelled
RT-Thread BSP Static Build Check / mips (push) Has been cancelled
RT-Thread BSP Static Build Check / nordic(yml) (push) Has been cancelled
RT-Thread BSP Static Build Check / nuvoton (push) Has been cancelled
RT-Thread BSP Static Build Check / nxp_renesas (push) Has been cancelled
RT-Thread BSP Static Build Check / others_at32_hc32_ht32 (push) Has been cancelled
RT-Thread BSP Static Build Check / riscv-none (push) Has been cancelled
RT-Thread BSP Static Build Check / riscv64-unknown (push) Has been cancelled
RT-Thread BSP Static Build Check / simulator (push) Has been cancelled
RT-Thread BSP Static Build Check / stm32_f2_f4 (push) Has been cancelled
RT-Thread BSP Static Build Check / stm32_f7_g0_h7_mp15_u5_h5_wb5 (push) Has been cancelled
RT-Thread BSP Static Build Check / stm32l4_f0_f1 (push) Has been cancelled
BSP compilation with more drivers / BSP Compilation with More Drivers (push) Has been cancelled
doc_doxygen / doxygen_doc generate (push) Has been cancelled
doc_doxygen / deploy (push) Has been cancelled

* doxygen: add prefix for groups

Add "group_" prefix to doxygen group names. This makes
it easier to grep with group name later.

This patch only modifies the groups defined in the pathes
of INPUT of documentation/Doxyfile:

INPUT = . \
        ../src \
        ../include \
        ../components/finsh \
        ../components/drivers/include/drivers \
        ../components/drivers/clk \
        ../components/dfs/dfs_v2/src \
        ../components/dfs/dfs_v2/include

Other groups are not touched.

Signed-off-by: Chen Wang <unicorn_wang@outlook.com>

* ci: fixed error report when run file_check.py

Such as:
- "please delete extra space at the end of this line."
- "the RT-Thread error code should return negative value. e.g. return
  -RT_ERROR"

Signed-off-by: Chen Wang <unicorn_wang@outlook.com>

---------

Signed-off-by: Chen Wang <unicorn_wang@outlook.com>
This commit is contained in:
Chen Wang
2025-02-15 12:15:19 +08:00
committed by GitHub
parent f6f7d91a61
commit c40b79037c
47 changed files with 233 additions and 233 deletions

View File

@@ -109,7 +109,7 @@ typedef long (*syscall_func)(void);
/**
* @ingroup finsh
* @ingroup group_finsh
*
* This macro exports a system function to finsh shell.
*
@@ -119,7 +119,7 @@ typedef long (*syscall_func)(void);
#define FINSH_FUNCTION_EXPORT(name, desc)
/**
* @ingroup finsh
* @ingroup group_finsh
*
* This macro exports a system function with an alias name to finsh shell.
*
@@ -130,7 +130,7 @@ typedef long (*syscall_func)(void);
#define FINSH_FUNCTION_EXPORT_ALIAS(name, alias, desc)
/**
* @ingroup finsh
* @ingroup group_finsh
*
* This macro exports a command to module shell.
*
@@ -144,7 +144,7 @@ typedef long (*syscall_func)(void);
_MSH_FUNCTION_CMD2)(__VA_ARGS__)
/**
* @ingroup finsh
* @ingroup group_finsh
*
* This macro exports a command with alias to module shell.
*
@@ -155,7 +155,7 @@ typedef long (*syscall_func)(void);
* @code
* #define MSH_CMD_EXPORT_ALIAS(command, alias, desc) or
* #define MSH_CMD_EXPORT_ALIAS(command, alias, desc, opt)
* @endcode
* @endcode
*/
#define MSH_CMD_EXPORT_ALIAS(...) \
__MSH_GET_EXPORT_MACRO(__VA_ARGS__, _MSH_FUNCTION_EXPORT_CMD3_OPT, \

View File

@@ -127,7 +127,7 @@ const char *finsh_get_prompt(void)
}
/**
* @ingroup finsh
* @ingroup group_finsh
*
* This function get the prompt mode of finsh shell.
*
@@ -140,7 +140,7 @@ rt_uint32_t finsh_get_prompt_mode(void)
}
/**
* @ingroup finsh
* @ingroup group_finsh
*
* This function set the prompt mode of finsh shell.
*
@@ -210,7 +210,7 @@ static rt_err_t finsh_rx_ind(rt_device_t dev, rt_size_t size)
}
/**
* @ingroup finsh
* @ingroup group_finsh
*
* This function sets the input device of finsh shell.
*
@@ -251,7 +251,7 @@ void finsh_set_device(const char *device_name)
}
/**
* @ingroup finsh
* @ingroup group_finsh
*
* This function returns current finsh shell input device.
*
@@ -265,7 +265,7 @@ const char *finsh_get_device()
#endif /* !defined(RT_USING_POSIX_STDIO) && defined(RT_USING_DEVICE) */
/**
* @ingroup finsh
* @ingroup group_finsh
*
* This function set the echo mode of finsh shell.
*
@@ -280,7 +280,7 @@ void finsh_set_echo(rt_uint32_t echo)
}
/**
* @ingroup finsh
* @ingroup group_finsh
*
* This function gets the echo mode of finsh shell.
*
@@ -461,7 +461,7 @@ static void shell_push_history(struct finsh_shell *shell)
static void (*_finsh_thread_entry_hook)(void);
/**
* @ingroup finsh
* @ingroup group_finsh
*
* @brief This function set a hook function at the entry of finsh thread
*
@@ -755,7 +755,7 @@ __declspec(allocate("FSymTab$z")) const struct finsh_syscall __fsym_end =
#endif
/*
* @ingroup finsh
* @ingroup group_finsh
*
* This function will initialize finsh shell
*/