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

オープン
#709 コメント 2 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
3/5
見積もり時間
1〜2日
初心者へのやさしさ
45/100
issue の種類
バグ
明瞭さ
明確に書かれている
活発さ
停滞
技術スタック
cpp
領域
devtools

調査の方向性

UndocumentedUserDefinedType.ql を調査し、AUTOSAR A2-7-3 における、提供された C++ の型エイリアスとテンプレートの例でレポートを再現してください。template_type へのドキュメント化されたエイリアスが報告される理由を追跡し、その後、クエリが a2_7_3_fp_alias を報告しなくなり、なおかつ実際にドキュメント化されていないユーザー定義型を引き続き検出することを確認してください。

索引モデルが issue の本文から書いたものです。

説明

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. |
主要言語
CodeQL
スター
227
フォーク
82
平均マージ
6日 7時間
マージ済み PR（30日）
9

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

github/codeql-coding-standards のほかの issue

github/codeql-coding-standards の issue をすべて見る

似ている issue

DevTools の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。