doxygenでmongodbのドキュメントを作ってみる
いつからか覚えてないが
自分の利用している(利用したい)オープンソースのソースを
読んで理解したい!という思いがあり、思うだけで終わって今に至る。。。
が、しかし、ひょんな事からmongodbに出会い、ソースコードリーディングが開催されると聞きつけ無謀にも手を上げてみた。。
で、とりあえず右も左もわからないが
参考にするべくdoxygenでドキュメントを作るところから
始めてみる
環境
mac osx snow leopard
mongodb 1.8.1
doxygen 1.7.3
手順
mongodbのソース取得
cd ~/Downloads/ curl -o http://downloads.mongodb.org/src/mongodb-src-r1.8.1.tar.gz tar zxf mongodb-src-r1.8.1.tar.gz
mongodbに入っているdoxygen用config利用してdoxygen実行
cd ~/Downloads/mongodb-src-r1.8.1 cp doxygenConfig Doxyfile vim Doxyfile ================================ ※defaultだと出力先がdocs/doxygenになっているのでお好みで変更 自分はDesktop上にフォルダ作って吐き出しました OUTPUT_DIRECTORY = docs/doxygen ↓ OUTPUT_DIRECTORY = /Users/oasis/Desktop/mongodb_docs ================================ /opt/local/bin/doxygen
一応問題なくできたので
つらつらと眺めてみながらどの辺から読み込むかを
考える。。。。
参考にさせていただいたサイト
http://www.kfield.co.jp/blog/2009/09/post20090925153832.html