googleapis / googleapis/google-cloud-cpp

Restore missing types in reference docs

Abierto
#14,412 2 comentarios 0 reacciones 0 asignados Ver en GitHub
cpp: docfx cpp: operator type: cleanup
Lenguaje dominante
C++
Estrellas
659
Forks
462
Merge medio
1 d 2 h
PR fusionados (30 d)
89

Descripción

Certain symbols (e.g. `MakeGoogleDefaultCredentials()`) are missing from our reference docs. The missing types have an `@ingroup foo`. Doxygen renders these as `` tags, which we skip in our docfx -> yaml conversion:

https://github.com/googleapis/google-cloud-cpp/blob/4ce192283831c5f0d815b84462bb53fa294a03af/docfx/doxygen2yaml.cc#L62-L66

The docs for `google-cloud-cpp` version >= `v2.23.0` are affected. When we have a fix, we ought to backport it to the older versions.

Guía de contribución

Abrir la guía de contribución

Línea de trabajo

Comienza en docfx/doxygen2yaml.cc, alrededor de las líneas 62-66, y reproduce la conversión de los símbolos con una anotación @ingroup foo, incluido MakeGoogleDefaultCredentials(). Verifica que la documentación de referencia afectada para las versiones de google-cloud-cpp >= v2.23.0 contenga los tipos que faltan después de la conversión y, a continuación, evalúa el backport a versiones anteriores.

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

Evaluación

Stack tecnológico
cpp
Área
documentation
Tipo de issue
Error
Dificultad
4/5
Tiempo estimado
3-5 días
Estado de actividad
Estancado
Claridad
Bastante claro
Aptitud para principiantes
45/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.