Exclude test folder from Doxygen API reference

Aperta
  • Qualcosa non va?
#1,341 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

  • #1441 di @wyf027 — chiusa senza merge

Valutazione

Difficoltà
1/5
Tempo stimato
Meno di un'ora
Idoneità per principianti
35/100
Tipo di issue
Bug
Chiarezza
Specificata chiaramente
Stato di attività
Ferma
Stack tecnologico
cmake, cpp
Ambito
documentation

Direzione di ricerca

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.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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

Lingua principale
C++
Stelle
6.1k
Fork
2.2k
Merge medio
22h 2m
PR unite (30g)
1

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di jbeder/yaml-cpp

Tutte le issue di jbeder/yaml-cpp

Issue simili

Altre issue su C++

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.