`A2-7-3`: documented type alias to template instantiation considered undocumented

Offen

#709 erstellt am 22.9.2024 2 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit: 3/5
Geschätzter Aufwand: 1-2 Tage
Anfängerfreundlichkeit: 45/100

Issue-Typ: Bug
Klarheit: Klar beschrieben
Aktivitätsstatus: Veraltet
Tech-Stack: cpp
Bereich: devtools

Rechercherichtung

Untersuchen Sie UndocumentedUserDefinedType.ql und reproduzieren Sie die Meldung mit dem bereitgestellten C++-Typalias- und Template-Beispiel unter AUTOSAR A2-7-3. Verfolgen Sie, warum der dokumentierte Alias für template_type gemeldet wird, und überprüfen Sie, dass die Abfrage a2_7_3_fp_alias nicht mehr meldet, während sie weiterhin tatsächlich nicht dokumentierte benutzerdefinierte Typen erkennt.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

Difficulty-Medium false positive/false negative Impact-Low Standard-AUTOSAR user-report

Affected rules

A2-7-3

Description

A documented type alias where type-id is a template results in a missing documentation false positive. If the rhs of the (documented) alias declaration does not involve a template, then there is no alert.

Example


/// @brief Template type template_type description.
///
/// @tparam template parameter T.
template<typename T> struct template_type {};

/// @brief Alias to int a_documented_alias.
using a_documented_alias = int;

/// @brief Alias a2_7_3_fp_alias to instantiated template_type with int template parameter.
using a2_7_3_fp_alias = template_type<int>;

Running query UndocumentedUserDefinedType.ql, AUTOSAR A2-7-3, will evaluate to

| declaration of a2_7_3_fp_alias | Declaration entry for user-defined type a2_7_3_fp_alias is missing documentation. |

Vorherrschende Sprache: CodeQL
Sterne: 227
Forks: 82
Ø Merge: 6 T. 7 Std.
Gemergte PRs (30 T.): 9

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
Forken Sie das Repository und arbeiten Sie in einem Branch.
Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus github/codeql-coding-standards

`RULE-10-0-1`: Structured bindings should not be reported as violations Offen

false positive/false negative Stardard-MISRA-C++

Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 72/100

github/codeql-coding-standards#1172 · Erstellt am 05.8.2026
`RULE-10-4`: False negatives as rule does not currently consider ternaries Offen

Difficulty-Low false positive/false negative false-negative Impact-Low Standard-MISRA-C

Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 68/100

github/codeql-coding-standards#821 · Erstellt am 12.12.2024
`EXP39-C`: False positives related to compatible types, harmless casts Offen

Difficulty-Medium false positive/false negative false-positive Impact-Medium Standard-CERT-C

Schwierigkeit 4/5 3-5 Tage Anfängerfreundlichkeit 48/100

github/codeql-coding-standards#1200 · Erstellt am 20.9.2026
`RULE-0-0-1`: "unreachable statement" false positives due to over-pruning of the control-flow graph Offen

false positive/false negative

Schwierigkeit 4/5 3-5 Tage Anfängerfreundlichkeit 48/100

github/codeql-coding-standards#1190 · Erstellt am 28.8.2026
`RULE-0-1-1`: Findings should be suppressed for [[maybe_unused]] initialization Offen

false positive/false negative

Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 65/100

github/codeql-coding-standards#1175 · Erstellt am 20.8.2026

Alle Issues in github/codeql-coding-standards