-
Notifications
You must be signed in to change notification settings - Fork 28
Knowledgebase Programming: Doxygen
oktal3700 edited this page Oct 12, 2023
·
1 revision
@{
…@}
has two different uses:
- copying the same documentation among (ungrouped) members;
- arranging members into groups.
The syntax has a subtle difference between these two uses, which can lead to bugs in the documentation:
- For copying documentation among members, the
@{
must be before the description. - For arranging members into groups, the
@{
must be after the description.
//! @{
//! Same documentation for both members.
void func1InGroup1();
void func2InGroup1();
//! @}
//! \name Group2
//! Description of group 2.
//! @{
void func1InGroup2();
void func2InGroup2();
//! @}
- Home
- API documentation (Doxygen generated)
- Future of swift
- Style and Coding Standard
- Release Checklist
- Build swift
- Run swift as a developer
- Knowledgebase
- External resources
- Open Research Questions
- Aviation
- Programming
- Simulation
- Architecture