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

Abierto
#709 2 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
3/5
Tiempo estimado
1-2 días
Aptitud para principiantes
45/100
Tipo de issue
Error
Claridad
Bien especificado
Estado de actividad
Estancado
Stack tecnológico
cpp
Área
devtools

Línea de trabajo

Inspeccione UndocumentedUserDefinedType.ql y reproduzca el informe con el ejemplo proporcionado de alias de tipo y plantilla de C++ bajo AUTOSAR A2-7-3. Rastree por qué se informa del alias documentado a template_type y verifique que la consulta ya no informe de a2_7_3_fp_alias, sin dejar de detectar tipos definidos por el usuario que realmente no estén documentados.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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. |
Lenguaje dominante
CodeQL
Estrellas
227
Forks
82
Merge medio
6 d 7 h
PR fusionados (30 d)
9

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de github/codeql-coding-standards

Todos los issues de github/codeql-coding-standards

Issues similares

Más issues de DevTools

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.