Doc: Apply cog to Link.h and Link.cpp

Cog is reapplied to create improved documentation for LinkParams.  See
LinkParams.py
This commit is contained in:
Pieter Hijma
2025-10-17 15:19:14 +02:00
parent 16592cae48
commit 401400cbcd
3 changed files with 66 additions and 81 deletions

View File

@@ -90,8 +90,9 @@ def declare_begin(module, header=True):
f"""
{trace_comment()}
namespace {namespace} {{
/** {class_doc}
/**
* @brief {class_doc}
*
* The parameters are under group "{param_path}"
*
* This class is auto generated by {param_file}. Modify that file
@@ -137,8 +138,8 @@ public:
cog.out(
f"""
{trace_comment()}
//@{{
/// Accessor for parameter {param.name}"""
/// @name {param.name} accessors
/// @brief Accessors for parameter {param.name}"""
)
if param._doc:
cog.out(
@@ -152,6 +153,7 @@ public:
)
cog.out(
f"""
/// @{{
static const {param.C_Type} & get{param.name}();
static const {param.C_Type} & default{param.name}();
static void remove{param.name}();
@@ -165,7 +167,7 @@ public:
)
cog.out(
f"""
//@}}
/// @}}
"""
)