Viết tên các không gian tên trải rộng nhiều tệp doxygen

Question

Hãy xem xét tôi có 2 tệp tiêu đề.

// HEADER 1 
/** 
* Doc for Foo here? 
*/ 
namespace Foo { 
    class This {...}; 
} 

& &

// HEADER 2 
/** 
* Doc for Foo here? 
*/ 
namespace Foo { 
    class That {...}; 
} 

Làm thế nào tôi nên xử lý này khi tài liệu với Doxygen?

Answer 1

Có thể không.

Ví dụ: hãy tưởng tượng bạn có "<root>/utility/header1.hpp" có nội dung trong số namespace utility và "<root>/utility/header2.hpp" cũng có.

Bạn có thể thêm tệp: "<root>/utility.hpp" để ghi lại không gian tên tiện ích. Bạn có thể đặt điều này ở đầu trang #error Documentation only. để đảm bảo không được bao gồm vô tình.

Nhưng tôi muốn giới thiệu ít nhất làm cho một số tập tin out-of-the-cách để giữ nó ở một nơi lành mạnh (và không trộn lẫn trong một cách ngẫu nhiên với một số lớp.)

Answer 2

Tìm nơi tốt nhất cho các tài liệu, cho dù đó là một trong những tập tin đó hay hoàn toàn khác. Sử dụng một khối bình luận với thẻ namespace Doxygen của:

/** 
* @namespace Foo 
* Documentation for Foo here. More docs for Foo here, 
* and down here. 
*/ 

Documents ở đây: http://www.stack.nl/~dimitri/doxygen/commands.html#cmdnamespace