2009-10-25 22 views
11

Tôi muốn loại trừ một lớp học khỏi tài liệu trong Doxygen. Thông thường các lớp này nằm trong các tệp có tên giống nhau, nhưng có nhiều lần khi chúng được đưa vào bên trong các định nghĩa lớp khác. Đây là chủ yếu cho các lớp học bắt đầu bằng "_" hoặc "Riêng tư".Doxygen có thể loại trừ một lớp C++ như thế nào?

Làm cách nào tôi có thể yêu cầu Doxygen loại trừ một lớp C++?

Xin cảm ơn trước.

Trả lời

14

Bạn có thể sử dụng the \cond tag. Trước khi định nghĩa lớp, thêm:

\cond HIDDEN_SYMBOLS 

và sau khi định nghĩa lớp thêm:

\endcond 

Trừ khi bạn xác định HIDDEN_SYMBOLS trong doxyfile của bạn, nội dung giữa \cond\endcond thẻ sẽ không được ghi lại. Bạn có thể thay thế HIDDEN_SYMBOLS bằng bất kỳ thứ gì bạn thích.

+0

Có cách nào để làm điều đó trong các nguồn không có '\ cond' và' \ endcond' không? Có lẽ một cái gì đó như '\ nodoc' hoặc' \ nodoxygen' trên lớp? Tôi không thấy một lệnh trong sổ tay Doxygen theo [Lệnh đặc biệt] (https://www.stack.nl/~dimitri/doxygen/manual/commands.html), nhưng tôi có thể đã bỏ lỡ nó. – jww

1

Sử dụng Doxygen GUI bạn có thể tìm thấy nhiều loại trừ lựa chọn dưới

"expert > input" 

Bạn có thể tìm thấy đặc biệt hữu ích:

  • Loại trừ biểu tượng: Không bao gồm tất cả mọi thứ có chứa một regex từ quyết tâm như /từ/
  • Loại trừ mẫu: Loại trừ regex đường dẫn được xác định như /thư mục/ hoặc /me/file.cs/
Các vấn đề liên quan