Tôi muốn thêm (phi dự án) tập tin tùy chỉnh để tạo ra một số trang thêm với Doxygen.Làm thế nào để bao gồm các file tùy chỉnh trong Doxygen
Tôi (đã thực sự) chắc chắn về cách những tập tin này nên được đặt tên và làm thế nào nội dung của họ nên được định dạng.
tôi có được tìm kiếm khá nhiều trước khi tôi tìm thấy câu trả lời, vì vậy tôi nghĩ rằng nó sẽ được tốt đẹp để chia sẻ!
Theo Doxygen gotchas bài viết này cuối cùng tôi phát hiện ra rằng: bạn cần phải thêm một tập tin với DOX mở rộng. nội dung của nó nên chứa C-phong cách bình luận khối:
/*!
\page My test page
contents
...
more contents
*/
Hãy chắc chắn rằng tập tin tùy chỉnh của bạn được đặt trong một thư mục được bao gồm trong INPUT thiết lập hoặc trong thư mục hiện nếu INPUT là bỏ trống, vì vậy những tập tin này có thể được tìm thấy .
Chỉ cần liệt kê các file tùy chỉnh của bạn trong vĩ mô INPUT trong doxyfile của bạn. Bạn có thể chọn bất kỳ tên nào bạn thấy phù hợp. Định dạng là văn bản với thẻ Doxygen.
Tôi đã thử điều đó, nhưng tệp đã được đưa vào dưới dạng tệp nguồn (được thêm vào danh sách tệp). Sử dụng phần mở rộng dox dường như để ngăn chặn điều này – Veger
Chỉ cần cho đầy đủ: có 3 phần mở rộng có thể được xử lý như Doxygen tập tin bổ sung tài liệu: .dox, .txt, và .doc.
tập tin mà gia hạn được ẩn từ chỉ số tập tin. Bên trong tệp, bạn cần đặt một hoặc nhiều khối chú thích kiểu C/C++.
Để hoàn thiện hơn nữa, bắt đầu với phiên bản Doxygen 1.8 (tôi tin), bây giờ nó hỗ trợ các tệp văn bản bổ sung rất giống với cú pháp markdown. Bạn không còn cần sử dụng các khối chú thích kiểu C/C++ nữa. Thay vào đó, chỉ cần viết gần như văn bản thông thường và đảm bảo rằng tệp văn bản nằm trong đường dẫn INPUT và quét doxygen của bạn thực sự tìm kiếm tệp có đuôi .markdown (hoặc bất kỳ tiện ích mở rộng nào khác mà bạn chọn sử dụng, như .md).
Tôi không tích cực (có thể coi đây là câu hỏi) nhưng tôi không thấy cách thêm lệnh như \ chấm vào tài liệu đánh dấu. – pedz
@pedz: Đã một thời gian kể từ khi tôi chơi đùa với Doxygen (chuyển đổi công việc một lúc), vì vậy đừng nhớ tất cả chi tiết. Bạn không thể thêm bất kỳ thẻ tùy chỉnh nào vào đánh dấu. Nó phải được hỗ trợ bởi trình phân tích cú pháp, nhưng tôi tin rằng "\ dot" là một thẻ hợp lệ: http://www.stack.nl/~dimitri/doxygen/manual/commands.html#cmddot. vì vậy có thể a) bạn không có phiên bản đúng hoặc b) trong tệp cấu hình của mình mà bạn không chỉ định công cụ DOT có sẵn. – DXM
Để rõ ràng:
Trong tập tin cấu hình .dox, thêm các tập tin để chỉ thị đầu vào với một cái gì đó như thế này:
INPUT = ../src \
../include \
../docs/my-extra-file.txt
Nếu tập tin có phần mở rộng thích hợp, nói như .h hoặc .c sau đó Doxygen sẽ tìm thấy tệp mà không cần thêm vào chỉ thị INPUT. Bên trong tập tin sử dụng các thẻ bình thường Doxygen, như trong nguồn, tức là bên trong khối bình luận, như:
/*! \mainpage MyProject - A Brief Description.
\image html Mylogo.png
\section my-intro MyProject Introduction
\htmlinclude about-MyProject.html
*/
Người ta cũng có thể chỉ cần sử dụng một trong những bao gồm các thẻ, giống như "\ htmlinclude" trong ví dụ trên, bất kỳ nơi trong mã.
Tôi nghĩ rằng có một lỗi nhỏ trong mẫu mã của bạn. Mã thông báo trước lệnh đặc biệt 'page' phải là" @ "hoặc" \ ". Tôi đã cố gắng sử dụng mẫu của bạn như là nhưng trang đã không được tạo ra, tuy nhiên với sửa chữa nhỏ mà nó làm việc. – wil
Đánh dấu là bây giờ cũng có sẵn. [Đây] (http://stackoverflow.com/a/9522667/339872) cách sử dụng nó. – antitoxic