« 1GspsのADCボードのひずみ | トップページ | Cosmo-ZをPythonで遠隔操作してグラフ描画 »

2017.10.11

Cosmo-Z ライブラリ 2.0のマニュアルを執筆開始

Cosmo-ZライブラリのマニュアルはDoxygenで書くことにしました。

http://www.tokudenkairo.co.jp/cosmoz/apidoc

長久しぶりのDoxygenですが、なんとか書き方を思い出して書いています。

Dox1

Dox2

整ったマニュアルが手軽に生成できるのはいいですね。

Doxygenを使う上でハマった点を書きます。

ファイルの最初に@fileがないとドキュメント化されないようなのですが、

/******************************************************************************
@file  document.h
@brief ライブラリマニュアルのメインページを記述している
******************************************************************************/

のように@briefの前に何もないとだめで、

/******************************************************************************
* @file  document.h
* @brief ライブラリマニュアルのメインページを記述している
******************************************************************************/

と、* が必要なようです。

|

« 1GspsのADCボードのひずみ | トップページ | Cosmo-ZをPythonで遠隔操作してグラフ描画 »

コメント

コメントを書く



(ウェブ上には掲載しません)




« 1GspsのADCボードのひずみ | トップページ | Cosmo-ZをPythonで遠隔操作してグラフ描画 »