Exclude test folder from Doxygen API reference

Abierto
#1,341 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

  • #1441 de @wyf027 — cerrado sin fusionar

Evaluación

Dificultad
1/5
Tiempo estimado
Menos de una hora
Aptitud para principiantes
35/100
Tipo de issue
Error
Claridad
Bien especificado
Estado de actividad
Estancado
Stack tecnológico
cmake, cpp

Línea de trabajo

Start by reading the CMake configuration where Doxygen is set up and check how DOXYGEN_EXCLUDE_PATTERNS is currently configured. The issue suggests excluding the test directory; confirm the variable uses the correct source directory path and pattern. Done when test-folder classes no longer appear in the generated API reference.

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

Descripción

documentation enhancement help wanted

Hi,

This should probably not be in the docs:

https://codedocs.xyz/jbeder/yaml-cpp/classVeryLoooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooo72732a7a8cd04f0ab9551a6aaa86a0c2.html

You can exclude directories by setting the DOXYGEN_EXCLUDE_PATTERNS CMake variable, for example:

set(DOXYGEN_EXCLUDE_PATTERNS ${CMAKE_SOURCE_DIREC}/test/*)

Regards,
Jules

Lenguaje dominante
C++
Estrellas
6.1k
Forks
2.2k
Merge medio
22 h 2 min
PR fusionados (30 d)
1

Preparar el entorno

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 jbeder/yaml-cpp

Todos los issues de jbeder/yaml-cpp

Issues similares

Más issues de C++

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.