Skip to content

A2-7-3: Support doxygen grouping #391

Closed
@lcartey

Description

@lcartey

Affected rules

  • A2-7-3

Description

Doxygen allows you to provide documentation for a "group" of declarations at once - for example, for all overloads of a function. We should consider this when determining whether a declaration is documented.

Example

Examples here: https://www.doxygen.nl/manual/grouping.html, including:

class Memgrp_Test
{
  public:
    ///@{
    /** Same documentation for both members. Details */
    void func1InGroup1();
    void func2InGroup1();
    ///@}
 
    /** Function without group. Details. */
    void ungroupedFunction();
    void func1InGroup2();
  protected:
    void func2InGroup2();
};

Metadata

Metadata

Assignees

Labels

Difficulty-MediumA false positive or false negative report which is expected to take 1-5 days effort to addressImpact-Lowfalse positive/false negativeAn issue related to observed false positives or false negatives.user-reportIssue reported by an end user of CodeQL Coding Standards

Type

No type

Projects

Status

Done

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions