Skip to content

A2-7-3: missing documentation when there's a comment after doxygen grouping #718

Closed
@fjatWbyT

Description

@fjatWbyT

Affected rules

  • A2-7-3

Description

It appears that adding a comment after the closing characters of a member grouping triggers alerts for the methods inside.

Example

/// @brief Member group b.
struct memgrpb {
  /// @brief Group with comment at the end.
  ///@{
  void memgrpb_func0();
  void memgrpb_func1();
  ///@} End of group
};

/// @brief Member group d.
struct memgrpd {
  /// @brief Group without comment at the end.
  ///@{
  void memgrpd_func0();
  void memgrpd_func1();
  ///@}
};

memgrpb_func1 and memgrpb_func0 are evaluated with missing documentation (in contrast with the functions in memgrpd) on query cpp/autosar/src/rules/A2-7-3/UndocumentedUserDefinedType.ql.

Related to #391.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Difficulty-MediumA false positive or false negative report which is expected to take 1-5 days effort to addressImpact-MediumStandard-AUTOSARfalse 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

      pFad - Phonifier reborn

      Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

      Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


      Alternative Proxies:

      Alternative Proxy

      pFad Proxy

      pFad v3 Proxy

      pFad v4 Proxy