Exclude test folder from Doxygen API reference

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

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

  • #1441 @wyf027 による — マージされずにクローズ

評価

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

調査の方向性

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.

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

説明

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

主要言語
C++
スター
6.1k
フォーク
2.2k
平均マージ
22時間 2分
マージ済み PR(30日)
1

環境構築

はじめの一歩

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

jbeder/yaml-cpp のほかの issue

jbeder/yaml-cpp の issue をすべて見る

似ている issue

C++ の issue をもっと見る

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

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