Định cấu hình Doxygen để ẩn các tên hoặc từ khóa nhất định

Question

Tôi chỉ mới bắt đầu với Doxygen và đã thực hiện tìm kiếm đáng kể về điều này, vì vậy hãy tha thứ cho tôi nếu có câu trả lời rõ ràng.

Tôi đang làm việc trên một dự án được nhúng nơi các chức năng có thể được gắn thẻ là debug hoặc nodebug trước loại trả lại. Trong hầu hết các thư viện của chúng tôi, chúng tôi sử dụng macro có điều kiện để đặt libname_debug thành debug hoặc nodebug ở đầu tệp và sau đó mỗi hàm được bắt đầu bằng libname_debug.

Vì mục đích tài liệu, tôi muốn có Doxygen để lại libname_debug trong tài liệu chức năng. Nó làm lộn xộn danh sách hàm và làm cho việc xem các kiểu trả về của mỗi hàm trở nên khó khăn hơn.

Có thể gắn thẻ tệp theo cách nào đó để Doxygen để lại biểu tượng đó không? Hiện tại, tôi đang bao gồm từng trường hợp trong @ cond/@ endcond:

/** @cond */ libname_debug /** @endcond */ 

Nhưng đó là một nỗi đau và thêm đánh dấu bổ sung cho nguồn.

Answer 1

Bạn có thể xác định các macro trong tệp cấu hình doxygen. Một cái gì đó như thế này

PREDEFINED += libname_debug 

Answer 2

Ngoài ra còn có một số doxygen page giải thích cách xử lý các situt như vậy. Bạn sẽ cho phép MACRO_EXPANSION (mặc định là NO), nói với doxygen để chỉ mở rộng một số macro (EXPAND_ONLY_PREDEF) và thêm biểu tượng của bạn như vĩ mô với sự mở rộng trống:

ENABLE_PREPROCESSING = YES 
MACRO_EXPANSION  = YES 
EXPAND_ONLY_PREDEF  = YES 
PREDEFINED    = libname_debug=