Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

`A2-7-3`: template function prototypes with comments are not correctly detected

Open
#528 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
35/100
Issue type
Bug
Clarity
Mostly clear
Activity status
Stale
Tech stack
cpp
Domain
tooling

Research direction

Start with the cpp/autosar/undocumented-user-defined-type rule and reproduce the provided TemplateFunction example. Inspect how commented elements are handled for template function prototypes, especially the c.getCommentedElement() = de condition; done means the documented MyFunction is no longer incorrectly flagged.

Written by the indexing model from the issue text.

Description

Difficulty-Medium false positive/false negative Impact-High Phase III Standard-AUTOSAR user-report
Affected rules
  • cpp/autosar/undocumented-user-defined-type
Description

The query incorrect flags the function MyFunction.

Example
/// @brief MyFunction.
/// @tparam MyType template parameter.
/// @param  Parameter.
/// @return Return type.
template <typename MyType> auto MyFunction(MyType) -> MyType;

The condition c.getCommentedElement() = de doesn't hold for TemplateFunction.

Dominant language
CodeQL
Stars
227
Forks
82
Avg merge
6d 7h
Merged PRs (30d)
9

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from github/codeql-coding-standards

All issues in github/codeql-coding-standards

Similar issues

More DevTools issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.