Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

A2-7-3: Support doxygen grouping #391

Closed
lcartey opened this issue Oct 4, 2023 · 0 comments · Fixed by #640
Closed

A2-7-3: Support doxygen grouping #391

lcartey opened this issue Oct 4, 2023 · 0 comments · Fixed by #640
Assignees
Labels
Difficulty-Medium A false positive or false negative report which is expected to take 1-5 days effort to address false positive/false negative An issue related to observed false positives or false negatives. Impact-Low user-report Issue reported by an end user of CodeQL Coding Standards

Comments

@lcartey
Copy link
Collaborator

lcartey commented Oct 4, 2023

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();
};
@lcartey lcartey added Difficulty-Medium A false positive or false negative report which is expected to take 1-5 days effort to address false positive/false negative An issue related to observed false positives or false negatives. Impact-Low user-report Issue reported by an end user of CodeQL Coding Standards labels Oct 4, 2023
@nicolaswill nicolaswill self-assigned this Jul 12, 2024
@knewbury01 knewbury01 moved this from Triaged to Ready for review in Coding Standards Public Development Board Jul 16, 2024
@knewbury01 knewbury01 moved this from Ready for review to Done in Coding Standards Public Development Board Jul 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Difficulty-Medium A false positive or false negative report which is expected to take 1-5 days effort to address false positive/false negative An issue related to observed false positives or false negatives. Impact-Low user-report Issue reported by an end user of CodeQL Coding Standards
Projects
Development

Successfully merging a pull request may close this issue.

2 participants