Exclude test folder from Doxygen API reference

Đang mở
  • Có gì không ổn?
#1,341 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

  • #1441 của @wyf027 — đã đóng, không merge

Đánh giá

Độ khó
1/5
Thời gian dự kiến
Dưới một giờ
Mức phù hợp với người mới
35/100
Loại issue
Lỗi
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Đình trệ
Công nghệ
cmake, cpp
Lĩnh vực
documentation

Hướng nghiên cứu

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.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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

Ngôn ngữ chính
C++
Star
6.1k
Fork
2.2k
Merge trung bình
22 giờ 2 phút
Pull request đã merge (30 ngày)
1

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của jbeder/yaml-cpp

Tất cả issue của jbeder/yaml-cpp

Issue tương tự

Thêm issue về C++

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.