2017-03-26 18 views
0

doxygenスタイルのコメントを使用してコメントされたC++コードがあります。 以下のテンプレートを使用します。 ドキュメンテーション(内部対外部)の使用に応じて、生成されたhtmlの著者と日付を削除したいと考えています。 自動生成されたHTMLから作成者と日付を削除するオプションはありますか? ありがとう! ポールdoxygenから作成者と日付を削除しました。html

/*! 
* \file Document.h 
* \brief This header file will be useful for the doxygen. 
* 
* \author John.Doe 
* \bug No known bugs. 
* \date 3/20/2016 
*/ 

答えて

0

これはあなたのヘッダー形式への変更のいくつかの並べ替えなしに達成することは困難であろう。最初に試してみるべき最も重要なことは、Doxygen FAQで説明したように、\cond\endcondの条件付きコマンド(またはオプション)を使用することです。あなたが考えるかもしれません

もう一つのトリックは\author\dateは、隣接するライン上にあるように、あなたの\bug\dateコマンドを並べ替えるためにあなたを必要とします。あなたはそれをした場合は、のようになり、あなたのヘッダーは次のとおりです。

/*! 
* \file Document.h 
* \brief This header file will be useful for the doxygen. 
* 
* \author John.Doe 
* \date 3/20/2016 
* \bug No known bugs. 
*/ 

この方法で物事を注文すると、あなたが探している結果を得るためにあなたのDoxygenの設定ファイルに別名トリックのビットを使用することができます。 \author\bugの定義を変更することで、Doxygenにコメントコマンドを挿入し、その間に作成者と日付情報を無視してコメントコマンドを挿入するよう指示することができます。設定ファイルで以下の行を使用すると、すべてのHTML出力から作成者/日付エントリが消えます。

ALIASES = author="<!--" 
ALIASES += bug="-->\bug" 

これはまさにDoxygenの設計機能ではありませんが、それはトリックを行うべきハックです。

0

完全に著者と日付を削除します。

この情報は、doxygenであるべきではありません。これは、ソース管理の管理(つまり、git)が対象です。

0

あなたはdoxygenの\internalコマンドを使用することができます - 基本的にあなたがわずかにあなたのヘッダーの例を微調整する必要があると思いhttp://www.stack.nl/~dimitri/doxygen/manual/commands.html#cmdinternal

を参照してください。そして、あなたのDoxyfileという中で、あなたがINTERNAL_DOCS設定を無効/有効にすることができ

/*! 
* \file Document.h 
* \brief This header file will be useful for the doxygen. 
* 
* \bug No known bugs. 
* \internal 
* \author John.Doe 
* \date 3/20/2016 
*/ 

\if\condコマンドは、表示される内容をより細かく制御できるため、ユーザーグループごとに異なるバージョンのドキュメントを3つ以上用意することができます。 http://www.stack.nl/~dimitri/doxygen/manual/commands.html#cmdif

関連する問題