2011-06-14 40 views
12

Tôi muốn đưa thư mục vào tài liệu doxygen.Cách đưa thư mục vào tài liệu doxygen?

Tôi đã thử \ trang và \ bao gồm nhưng chưa hoạt động, có ai biết cách thực hiện không? Đây là cây:

+0

Điều này hữu ích: http://comments.gmane.org/gmane.text.doxygen.general/8425? –

+0

Tôi muốn biết thư mục chứa những gì. Hình ảnh? Các lớp học được ghi chép? Các tệp HTML sẽ được bao gồm? – cweiske

+0

@cweiske thư mục chứa các lớp được ghi thành tài liệu –

Trả lời

19

Để thêm vào các ý kiến ​​về câu hỏi của bạn, lệnh \ trang sẽ thêm trang vào tài liệu của bạn mà bạn đã tự viết. I E. nếu tệp nguồn chứa khai báo \ page, nó sẽ thêm nội dung vào chỉ mục tài liệu. Bạn có thể thêm giúp đỡ thêm ở đây, chẳng hạn như:

/*! \page overviewpage Architecture Overview 
* 
* \section memorymanagement Memory Management 
* 
* Some writing you want to appear as a help page in the documentation here. 
*/ 

Các \ include lệnh sẽ bao gồm một bản sao của một tập tin như là một khối mã nguồn.

Tôi nghĩ bạn đang thực sự hỏi làm thế nào bạn có được Doxygen để thêm nhiều thư mục nguồn. Miễn là các thiết lập đệ quy là YES, mà không phải là mặc định, nó sẽ làm việc tốt cho cấu trúc của bạn nếu bạn đã thiết lập thư mục gốc như đầu vào Doxygen.

RECURSIVE    = YES 

Nếu chưa, bạn có thể thêm các thư mục khác như thế này, với đường dẫn tương ứng với tệp Doxyfile.

#--------------------------------------------------------------------------- 
# configuration options related to the input files 
#--------------------------------------------------------------------------- 

# The INPUT tag can be used to specify the files and/or directories that contain 
# documented source files. You may enter file names like "myfile.cpp" or 
# directories like "/usr/src/myproject". Separate the files or directories 
# with spaces. 

INPUT     = src test/src 
Các vấn đề liên quan