2013-03-19 57 views
4

我正在研究我們的軟件庫的新文檔,我想知道如何將我認爲應該用DocBook編寫的一般文檔與基於Doxygen的API參考結合在一起。結合Docbook和Doxygen文檔類型。

Doxygen部分已經存在,所以我寧願保留它,但使用DocBook只是一個想法,我願意接受任何想法。在Doxygen中編寫整個文檔是可能的,但在我看來,這並不是最好的方法。

謝謝!

+0

我對Docbook一無所知,但如果有辦法將輸出與其他Docbook文件結合使用,Doxygen可以輸出到Docbook。 – 2014-02-14 01:04:03

回答

1

我建議你重新考慮採取全Doxygen的方式。儘管使用Doxygen編寫精心編寫的文檔起初看起來很麻煩,但從長遠來看,保持兩個文檔的一致性將會有更多的工作。除了通過組合兩者的輸出產品而增加的工作量之外。

的Doxygen能夠包括降價文件,頁面插入文檔(參見手冊中的this section)和外化,以不吹你的源精細的文檔文件太多(請參見手冊中this other section)。

我還應該補充一點,我之前沒有使用Docbook的第一手經驗,所以可能會讓我偏向Doxygen。

+0

這是一個實際選擇。這不夠靈活,我更喜歡解決方案,但它足夠好。 – Ilya 2014-04-03 08:10:06