cách liên kết tới tài liệu của thư mục

Question

Tôi đã thêm một nhận xét \dir để cung cấp tài liệu bổ sung cho thư mục. Nhưng tôi không thể liên kết đến tài liệu thư mục đó bằng cách sử dụng bất kỳ kỹ thuật liên kết doxygen nào mà tôi biết. Câu hỏi của tôi là: làm cách nào để liên kết đúng với tài liệu của một thư mục?

Dưới đây là một đoạn trích về những gì tôi đã thử. Tôi nhận được hai cảnh báo và không có liên kết nào được tạo. Phần liên kết tự động của sổ tay doxygen thảo luận về Links to other members, nhưng nó không đề cập đến các liên kết đến các thư mục. Liên kết đến tài liệu thư mục có được hỗ trợ không? Nếu vậy, tôi đang làm điều gì đó sai hoặc là một lỗi này? (Tôi đang sử dụng 1.8.10 ngay bây giờ. 1.8.9.1 hành xử theo cùng một cách.)

Đây là những gì tôi đã thử. Tôi đã ghi thư mục sử dụng

/// \dir cpp/vtutil 
///  
/// \brief Brief description of the dir cpp/vtutil goes here 
/// 
/// \details A more detailed description goes here. 
///   

Và tôi tham khảo các thư mục sử dụng

/// \file 
/// \brief Implements the vt application class. 
/// 
/// This file is in the \ref cpp/vtutil directory. 
/// What about #cpp/vtutil 

Dưới đây là những lời cảnh báo:

warning : unable to resolve reference to `cpp/vtutil' for \ref command 
warning : explicit link request to 'cpp' could not be resolved 

Các tài liệu được sử dụng cho các thư mục, nhưng không thực hiện dường như là một cách để tham khảo nó. Tôi chân thành cảm kích sự giúp đỡ nào.

Answer 1

Cách chính xác để liên kết đến trang tài liệu cho một thư mục là sử dụng lệnh \ref. Các liên kết rõ ràng bằng cách sử dụng # cũng không được hỗ trợ cho các thư mục.

/// \file 
/// \brief Implements the vt application class. 
/// 
/// This file is in the \ref cpp/vtutil directory. 

Ví dụ này sẽ tạo liên kết đến tài liệu của thư mục cpp/vtutil. Tuy nhiên, cần phải cẩn thận khi sử dụng đường dẫn tuyệt đối và cài đặt cấu hình doxygen với STRIP_FROM_PATH. Khi tôi chạy doxygen với thư mục làm việc trong cây nguồn, tôi có thể lấy tham chiếu liên kết chính xác. Nhưng khi tôi chạy từ một thư mục xây dựng, mà là khác nhau từ thư mục nguồn của tôi, và cần phải sử dụng STRIP_FROM_PATH, sau đó tôi có vấn đề.

Doxygen là khá tha thứ hoặc linh hoạt với đường dẫn được sử dụng khi tạo tài liệu cho thư mục với lệnh \dir, nhưng nó khá khó khăn khi tham chiếu nó bằng lệnh \ref.