meta data for this page
  •  

Doxygen

http://micro-os-plus.github.io/develop/doxygen-style-guide/

/**
 * @file ...
 * @brief ...
 * @author
 * @date 2024-12-01
 * @version 1.0
 */
/**
 * @brief ...
 * @details
 * ...
 */

Function:

/**
 * @brief ...
 *
 * @param [in] c  ...
 * @return int
 * @retval -1 Error
 * @retval 0 oK
 *
 * @details
 * ...
 
 */

Variables and macros:

/**
 * @brief ...
 */
#define FOO 1
 
/**
 * @brief ...
 */
int poo;

Structs and enums:

/**
 * @brief ...
 */
typedef struct {
  int a;  /**< a var */
  int b;  /**< b var */
} my_t;