Phân tách "nội bộ" từ tài liệu "bên ngoài" trong doxygen

Question

Tôi muốn tài liệu thư viện với doxygen. Tài liệu sẽ được đọc bởi hai lớp người: Người dùng chỉ quan tâm đến API bên ngoài và nhà phát triển muốn xem tài liệu cho tất cả các chức năng/cấu trúc.

Tôi muốn sử dụng để tách các doxyfiles để tạo tài liệu. Có một số "thẻ" tôi có thể đặt trong một khối bình luận để đánh dấu một bình luận như nội bộ/bên ngoài?

Answer 1

Set INTERNAL_DOCS:

# The INTERNAL_DOCS tag determines if documentation 
# that is typed after a \internal command is included. If the tag is set 
# to NO (the default) then the documentation will be excluded. 
# Set it to YES to include the internal documentation. 

INTERNAL_DOCS   = NO 

Trong tài liệu hướng dẫn, bạn có thể sử dụng \internal hoặc @internal ở bất cứ granularity bạn muốn (tập tin, chức năng, vv).

Answer 2

Sử dụng \ cond lệnh:

\internal (@internal) chỉ có granularity cho khối bình luận hiện nay. Nó không cho phép bạn cách nào để che giấu một định nghĩa cấu trúc trong C.

Cách đơn giản nhất để làm điều này là đặt

\ cond NỘI

ở phía trên cùng của một tập tin tiêu đề nội bộ và

\ endcond

ở dưới cùng. Sau đó, trong tập tin cấu hình của bạn, bạn thêm

ENABLED_SECTIONS = NỘI

để cho phép các mặt hàng nội bộ để được bao gồm trong tài liệu.

Cách này cũng được người dùng Doxygen khuyên dùng, ví dụ: here

Answer 3

Đây là giải pháp đơn giản, sử dụng thực tế là bạn thường có thể phân biệt các phần bên trong và bên ngoài của mã của bạn thành tệp.

Bạn chỉ có thể giới hạn các tập tin đầu vào để chỉ những tập tin tiêu đề mà bạn muốn để lộ trong các tài liệu bên ngoài:

# For internal, we parse all files 
INPUT = ./ 
# For external, we parse only the files containing the public interface 
INPUT = include/header1.hpp include/header2.hpp 

này có ưu điểm là các tập tin nguồn không cần phải được sửa đổi (với \internal hoặc @internal).