Doxygen lặp lại các hàm C++ với các đối số mặc định

Question

Tôi đang sử dụng Doxygen để ghi lại một số mã của mình. Tôi đã có một hàm có sử dụng một đối số mặc định, được quy định trong ví dụ tiêu đề:

unsigned int CountColumns(const std::string&,const std::string& delim=""); 

và thực hiện tương ứng trong file nguồn như:

unsigned int CountColumns(const string& input,const string& delim) 
{ 
    ... 
} 

Khi tôi sử dụng Doxygen để tạo tài liệu của tôi, CountColumn có hai mục - một bao gồm giá trị mặc định và một không có:

unsigned int CountColumns (const string &input, const string &delim) 
unsigned int CountColumns (const std::string &, const std::string &delim="") 

Làm cách nào để tránh điều này? Tôi không muốn nhiều định nghĩa chức năng làm lộn xộn tài liệu của mình. EDIT: Như tôi cũng đã đề cập trong câu trả lời của tôi dưới đây, vấn đề xuất hiện là do thực tế là các tập tin tiêu đề sử dụng 'std :: string' trong các đối số, trong khi các tập tin nguồn bao gồm một 'bằng cách sử dụng std :: string 'statement và sau đó sử dụng' string 'trong các đối số. Nếu tôi thay đổi định nghĩa hàm để sử dụng 'std :: string' trong tệp nguồn, Doxygen nhận ra nó là hàm giống như được khai báo trong tiêu đề.

Answer 1

Tôi đề nghị đặt BUILTIN_STL_SUPPORT thành YES trong tệp cấu hình của bạn, doxygen biết chuỗi là một lớp được xác định trong tiêu chuẩn không gian tên.

Answer 2

Làm thế nào để loại trừ các chức năng bổ sung khỏi tài liệu?

này là từ Doxygen FAQ,

"Làm thế nào tôi có thể làm cho doxygen bỏ qua một số đoạn mã?

Cách mới và đơn giản nhất là thêm một khối bình luận với một lệnh \cond lúc bắt đầu và một . bình luận khối với một lệnh \endcond ở phần cuối của các đoạn mã mà nên bỏ qua này sẽ có trong cùng một tập tin tất nhiên

Nhưng bạn cũng có thể sử dụng tiền xử lý Doxygen của cho việc này:. Nếu bạn đặt

#ifndef DOXYGEN_SHOULD_SKIP_THIS 

    /* code that must be skipped by Doxygen */ 

#endif /* DOXYGEN_SHOULD_SKIP_THIS */ 
around the blocks that should be hidden and put: 

    PREDEFINED = DOXYGEN_SHOULD_SKIP_THIS 
in the config file then all blocks should be skipped by Doxygen as long as 

PREPROCESSING = YES. "

Answer 3

Vấn đề có vẻ là do tệp tiêu đề sử dụng 'std :: string' trong đối số, trong khi tệp nguồn bao gồm câu lệnh 'using std :: string' và sau đó sử dụng 'string Nếu tôi thay đổi định nghĩa hàm để sử dụng 'std :: string' trong tệp nguồn cũng vậy, Doxygen nhận ra nó giống như hàm đã khai báo trong tiêu đề.

Mặc dù không lý tưởng, nó là một giải pháp hoạt động và không quá khó sử dụng