Tài liệu khái niệm C++ sử dụng doxygen?

Question

Có cách nào thuận tiện để ghi lại khái niệm C++ trong doxygen không? Tôi muốn có một số loại tài liệu như this in the boost documentation.

Answer 1

Điều bạn có thể làm là xác định thẻ tùy chỉnh có tên là Khái niệm, sau đó bạn có thể sử dụng thẻ này như mô tả. Một example của việc này là sử dụng cơ chế bí danh trong Doxygen, một cái gì đó như:

bí danh + = "con = \ xrefitem con \" Khái niệm \ "\ "Các khái niệm \""

Answer 2

Bạn có thể sử dụng \tparam để nhận xét/tài liệu trên template parameters.

Answer 3

Tôi hiện đang sử dụng trang hướng dẫn riêng để ghi lại các khái niệm và nhóm với \section và \subsection. Sau đó tôi có thể liên kết với họ bằng \ref. Điều này hoạt động miễn là bạn mô tả các khái niệm có các bảng như trong liên kết bạn đã cung cấp, nhưng rất tiếc sẽ không cho phép các liên kết đến các phần đơn lẻ.

Tôi cũng có bí danh để tạo danh sách các khái niệm mô hình kiểu.

Answer 4

Sau khi gặp khó khăn với Doxygen, cuối cùng tôi đã đến giải pháp sau.

1. Xác định nhóm cho khái niệm của bạn: sử dụng các trang không phù hợp vì trang phải biểu thị các trang con của nó (từ trên xuống dưới); Điều này cho phép:

   • Thêm một khái niệm để một (hoặc nhiều) khái niệm mẹ (s), mà không thay đổi các khái niệm mẹ mình (tinh/tổng quát của khái niệm)
   • Linking một thực thể với một số khái niệm, mà không thay đổi khái niệm riêng của mình (ví dụ. khi thêm một lớp đến thư viện thực hiện một khái niệm cụ thể)

   Ví dụ

   /*!@defgroup measurement_functor_concepts Measurement function objects 
   * @ingroup generalconcepts 
   * @{ 
   * @par Description 
   * blablabla 
   * 
   * @par Notations 
   * Let @c F be the type of the function object, @c f an instance. 
   * 
   * @par Valid Expressions 
   * - @c f function object is ... 
   * - <b>f.result()</b> returns ... 
   * @} 
   */ 
   

2. Xác định lệnh tùy chỉnh concept với một đối số:

   ALIASES += concept{1}="@ingroup \1\n@par Implemented concepts:\n@ref \1" 
   

   Lệnh:

   • bao gồm các thực thể vào nhóm xác định các khái niệm: đơn vị sẽ xuất hiện trong tài liệu của khái niệm (các thực thể có thể xuất hiện trong một số nhóm)
   • thêm đoạn có số Implemented concepts cung cấp liên kết đến khái niệm được triển khai.

3. Cho biết một lớp học đặc biệt/struct thực hiện các khái niệm:

   //!@brief Does things... 
   //!@concept{measurement_functor_concepts} 
   template <class T> 
   struct my_struct: public std::unary_function<T, void> {}; 
   

tôi không tìm thấy một cách để tạo ra một tài liệu thoải mái như ở Boost (bảng tốt đẹp cho sự biểu hiện hợp lệ, vv), nhưng ít nhất tổ chức này của tài liệu phân tách mọi thứ một cách chính xác.

Answer 5

Tôi khuyên bạn nên cân nhắc những điều sau:

a) Xem tài liệu cho thư viện Kiểm tra khái niệm tăng cường. Tài liệu này cho bạn thấy cách tạo một lớp có thể được sử dụng trong mã của bạn để xác minh rằng ở loại thực sự đáp ứng các yêu cầu của khái niệm mà bạn muốn xác định. Bạn sử dụng nó như thế này:

template<typename T> 
my_class{ 
    MyConcept(T); // provokes compile error if T does not match concept 
    T m_t; 
}; 

FYI có một 1-1 tương ứng giữa các yếu tố được sử dụng trong việc tạo ra các lớp khái niệm kiểm tra và và các khái niệm đề nghị lite. Vì vậy, khi khái niệm lite thực sự hoạt động, quá trình chuyển đổi phải dễ dàng.

b) Bây giờ hãy sử dụng DOxygen để ghi lại lớp kiểm tra MyConcept!

c) Sử dụng Doxygen/tparam trên tài liệu my_class để chỉ MyConcept

c) Vì vậy, bây giờ bạn đã chính xác những gì bạn đang yêu cầu cho !!! - một trang riêng cho khái niệm của bạn và khả năng tham chiếu nó từ tất cả các lớp đòi hỏi khái niệm đó.