Tài liệu chức năng quá tải trong Doxygen (C++)

Question

Tôi đang cố ghi lại một số mã có quá nhiều tình trạng quá tải cho các chức năng khác nhau. Các chức năng này thực hiện tương tự theo những cách rất khác nhau.

Tôi muốn ghi lại tất cả các chức năng này cùng nhau bằng Doxygen, tương tự như cách thực hiện trong cppreference.com (example).

Có thể có hành vi tương tự trong Doxygen không? Nếu vậy, làm thế nào?

Answer 1

Có một câu hỏi tương tự: Grouping overloads in doxygen

Tôi nghĩ rằng câu trả lời đầu tiên, trả lời câu hỏi của bạn vì nó sẽ nhóm một tập hợp các hàm dưới một cái tên thống nhất. Tôi thực sự đã cho nó một thử sử dụng tiêu đề sau đây:

#ifndef TEST_H 
#define TEST_H 
/** 
* @brief Test Class 
*/ 
class Test 
{ 
public: 
    ///Default Constructor 
    Test(); 
    /** 
    * @name Overloaded methods 
    */ 
    //@{ 
    ///OverLoad1 
    void func1(void); 
    /** 
    * @brief Overload2 
    * @param a test variable 
    */ 
    void func1(int a); 
    //@} 
}; 
#endif //TEST_H 

Nếu bạn tạo tài liệu với gái giang hồ bạn sẽ thấy rằng các phương pháp quá tải được nhóm lại với nhau trong các mô tả ngắn gọn.

Tôi hy vọng điều đó sẽ hữu ích!