????doxygen是一個自動文檔生成工具奋隶,根據(jù)代碼里寫的注釋,自動生成html和latex格式的文檔。通常是給c++用的火惊,通常是出html格式的,你看到的pcl網(wǎng)上文檔就是拿doxygen生成的奔垦。
????事實上屹耐,隨意一份代碼,都可以拿doxygen生成一個文檔椿猎,然后在本地看它的代碼結(jié)構(gòu)惶岭。 我們拿以難讀著稱的lsd-slam舉個例子寿弱。
????由于你電腦里可能還沒有doxygen,我們先來安裝一下:????
sudo apt-get install doxygen doxygen-gui【主要是doxygen本體和它的gui模塊按灶。我在ubuntu14.04下是這兩個包名症革。如果你不確定,請用apt-cache search doxygen查一下鸯旁≡朊】
????在該文件夾下開一個doc文件夾,把一會兒生成的文檔放里頭:
mkdir doc
cd doc
doxywizard【調(diào)出gui面板】
首先羡亩,建個文件夾摩疑,把lsd-slam的代碼拷下來:
git clone https://github.com/tum-vision/lsd_slam.git
切到Run,點“Run doxygen"畏铆,等文檔生成完雷袋。然后點“show html output",就可以在瀏覽器里看到文檔啦辞居。如果你下一次想直接看楷怒,直接打開doc/html/index.html就可以了!