2016-11-13 14 views
0

Doxygenを使用してHTTP APIを文書化し、パラメータのあるHTTPクエリの説明と、クラスの説明と同様の結果を返すことが必要です。だから、私は\query\brief\param\returnのような構造コマンドがあり、上のナビゲーションメニューに対応する「クエリー」タブがあります。言い換えれば、\classの100%複製が必要ですが、単に別の名前を使用するだけです。これは可能ですか?Doxygenでカスタムオブジェクトタイプを作成することはできますか?

答えて

0

あなたが望むようにこれをきれいに行うことはできないと思いますが、これを達成する方法はグループを使用することです。

/** 
* \defgroup query Queries 
*/ 

はその後queryグループ

/** 
* \defgroup getUser Get User by Id 
* \ingroup query 
* \brief Some brief 
* \param Id user id 
* \return User for given id 
*/ 

でグループとして各クエリを文書化する今、あなたは、ナビゲーションメニューにqueryグループにタブを追加する必要があります。

最初にdoxygen -lを使用してdoxygenレイアウトファイルを生成します。次にdoxyfileにLAYOUTFILE = DoxygenLayout.xmlと設定します。

<navindex> 
    ... 
    <tab type="user" visible="yes" title="Queries" url="@ref query" intro=""/> 

は、最後に新しいタブを追加するために、あなたのDoxygenLayout.xmlファイルを変更します

関連する問題