如何在Doxygen中創建一個僅包含「公共」API文件的文件

Question

我有一個項目，我正在研究這是一個庫。爲了我自己的目的，我需要記錄庫代碼的內部結構，但也需要向我的用戶提供API文檔，以瞭解它們應該如何使用庫。

所以，我想給他們的文件，我想只包括「公共」的功能，結構，變量，等等 - 而不是的內部那些。

有沒有一種方法可以在Doxygen中做到這一點？我可以描述什麼是「公共」，什麼是「私人」？我可以爲我的用戶生成僅包含「公共」API的文檔，還可以爲我自己使用包含「私人」設計細節的單獨文檔？

注意：這是直C，而不是C++ - 而我對「public」和「private」這兩個術語的使用與「public」和「private」類成員無關。

Answer 1

根據您的需要，也有這樣做的幾種方法：

• 您可以使用\internal標籤
• 您可以的Doxyfile與EXTRACT_PRIVATE=NO一起使用\private標籤
• 和可能其他人蔘與各種EXTRACT_配置變量之一。