Apache HTTP Server 版本 2.4
Apache HTTP Server 版本 2.4
Apache 2.4 使用 Doxygen 編寫程式碼中的 API 和全域變數文件。這說明如何使用 Doxygen 編寫文件的基本知識。
若要開始編寫文件區塊，請使用 /**
若要結束編寫文件區塊，請使用 */
在區塊中間可使用多個標記
說明此功能的目的
@param parameter_name 說明
@return 說明
@deffunc 功能簽章
不一定需要 deffunc。DoxyGen 沒有完整的解析器，因此任何在回傳型別宣告中使用巨集的原型，都會過於複雜，無法由 scandoc 進行掃描。這些功能需要 deffunc。範例（使用 > 而不是 >）
/**
* 回傳路徑名稱的最後一個元素
* @param pathname 取得最後一個元素的路徑
* @return 路徑的最後一個元素
* @tip 範例
* <pre>
* "/foo/bar/gum" -> "gum"
* "/foo/bar/gum/" -> ""
* "gum" -> "gum"
* "wi\\n32\\stuff" -> "stuff"
* </pre>
* @deffunc const char * ap_filename_of_pathname(const char *pathname)
*/
請務必在標頭檔案的頂端包括以下內容
/**
* @package 函式庫標頭名稱
*/
Doxygen 為每個套件使用新的 HTML 檔案。HTML 檔案命名為 {函式庫標頭名稱}_html，因此請在命名時力求簡潔。
歡迎參考 Doxygen 網站，進一步探討其他可能性。