php - Doxygenおよびライセンス/著作権情報

Question

グーグルを掘ることができなかった簡単な質問があります。

プロジェクトのドキュメントをphpDocからDoxygenに移動していますが、 @licenseと@copyrightを一緒に記述する方法がわかりません。

私の概念では、 @ copyrightは私の「会社」（まだ本物ではない：P）の名前と@licenseのために設計されており、私が開発している方法を使用できます。ライセンス"...

Answer 1

クリスの答えに基づいて、このコマンドを使用\parして、組み込みコマンドと同様のブロックを作成できます\copyright。たとえば、次のようなエイリアス：

ALIASES += "license=@par License:\n"

このコメントを許可します：

/** My main function.

    \copyright Copyright 2012 Chris Enterprises. All rights reserved.
    \license This project is released under the GNU Public License.
*/
int main(void){
    return 0;
}

この出力を生成するには：

このソリューションでは、の前に空白行は不要\licenseであり、{}構文は不要であることに注意してください。また、HTML以外の形式のドキュメントを生成しようとした場合にも、問題が発生する可能性は低くなります。

Answer 2

著作権情報とライセンス情報の違いには同意しますが、doxygenはこれらに個別のコマンドを提供していないようです。実際、コマンドのドキュメントから、コマンド\authorは\copyrightライセンス情報を示すために使用されます。

ここでできることは（少なくとも）2つあります。

1. \copyright著作権とライセンス情報をコマンドの引数に組み合わせるだけです。

   /** My main function.
   
       \copyright Copyright 2012 Chris Enterprises. All rights reserved.
       This project is released under the GNU Public License.
   */
   int main(void){
       return 0;
   }
   

   これにより、HTMLが生成されます

   

   これはほぼ間違いなくあなたができる最も簡単なことです。

2. または、上記の画像を生成するために記述されたHTMLは次のとおりです。

   <dl class="section copyright"><dt>Copyright</dt><dd>Copyright 2012 Chris Enterprises. All rights reserved. This project is released under the GNU Public License. </dd></dl>
   

   これを利用して、たとえば、と呼ばれる新しいコマンドを定義licenseできます。このコマンドは、コマンドと同じように動作しcopyrightます。ALIASESdoxygen構成ファイルのフィールドに以下を配置します

   ALIASES += license{1}="<dl class=\"section copyright\"><dt>License</dt><dd>\1 </dd></dl>"
   

   上記のドキュメントブロックをに変更します

   /** My main function.
   
       \copyright Copyright 2012 Chris Enterprises. All rights reserved.
   
       \license{This project is released under the GNU Public License.}
   */
   

   doxygenで生成された出力を取得します

   

   この2番目の解決策には、いくつかの癖があることに注意してください。コマンドの前に空白行が\license{...}あり、\licenseコマンドは引数を中括弧で囲む必要があります。オプションでコマンドを使用してこれを行うことができますが、これら\copyrightを介して定義された引数を持つコマンドにALIASESは中括弧が必要です。