Pythonコードに例を追加しようとしています。クラス/モジュール/パッケージのヘルプに表示されるように、をどこに配置する必要がありますか?@example filename
現時点では、例のリストを取得するだけですが、classdocs から例へのリンクはありません。
クラスのドキュメント(ドキュメント文字列でタグを許可するためにdoxypy@example
を使用しています)、クラスの後、ファイルの一番上のコメントのすぐ下に@package
.
これは差し迫った問題ですが、もう 1 つの質問があります。タグを追加せずに、doxygen に examplefolder のすべての例を単純に解析させ、クラスと例の間の自動リンクを作成させることはできますか?
私は次の構造を持っています:projectcode/aTreeOfPackagesAndModules
とexamples/aTreeOfPackagesAndModules
. ツリーのレイアウトはまったく同じで、各パッケージのサンプル ファイルのパス/ファイル名は、交換されているprojectcode
/ディレクトリを除いてまったく同じです。examples
サンプルタグを追加できますか?