C語言文檔生成工具 GTK-Doc
GTK-Doc 是一個用來從C代碼的注釋中生成API文檔的工具,尤其適用于使用gobject對象機制編程的項目,并不局限于GTK+或GNOME相關library和程序的文檔生成。
主要工作流程
基本上,使用GTK-Doc生成API文檔,包括幾個步驟:
- 在項目相關目錄和Build相關文件中添加 GTK-Doc所需參數和相關配置文件。
- 在代碼中按照一定的格式規范添加注釋(于普通的注釋相比,只需要添加非常少的額外信息)
- 使用標準的Build流程(autogen,configure,make等)編譯并生成文檔
- 修改部分GTK-Doc生成的模板和配置文件,進行一些定制工作,如排除某些函數,定制布局,添加而外的help文檔等(這部分工作并不需要每次都做,這些模板和配置文件只在第一次build的時候生成,以后不會自動覆蓋)
本文由用戶 openkk 自行上傳分享,僅供網友學習交流。所有權歸原作者,若您的權利被侵害,請聯系管理員。
轉載本站原創文章,請注明出處,并保留原始鏈接、圖片水印。
本站是一個以用戶分享為主的開源技術平臺,歡迎各類分享!