Doxygenのtxtファイルを文書化する

私はDoxygenを使ってPythonプロジェクトを文書化しています。このアプリケーションは、いくつかの小さなtxtファイルを使用します。 (これらのファイルは存在しないかもしれません) - この文書を他のファイル(コードを含む)に書く必要があります。

問題は、1つのコードファイルで2つのファイルを処理できないことです(少なくとも、std doxyconfはそれを許可しません。マイナーなファイルや存在しないファイルは生成されません)

あなたはそれを克服する方法を知っていますか? confの具体的な調整は何をすべきか?あるいは、コメント(文書)のみを含む.pyファイル(問題のファイルと同じディレクトリ)を作成する必要がありますか?

前もって感謝します。

編集する。それをもっと明確にしよう。私のコードは次のファイルにあるとします:

(...)/project/functions.py
(...)/project/interface.py
(...)/project/data/js/functions.js

実行中の場合、アプリはいくつかのディレクトリを生成します:

(...)/project/data/gallery/gallery1
(...)/project/data/gallery/gallery2
(...)/project/data/gallery/gallery3

in gallery1, we have 3 jpgs and 3xmls, in gallery2 - 1 jpg, gallery3- 5xJPG & 5xXML. All of which - uploaded by the user. As galleries 1, 2 & 3 have a bit different usage, after creating these dirs, we create also a file:

(...)/project/data/gallery/types.info

このファイルには、次の形式の情報が含まれます。

gallery1#galleryType1
gallery2#galleryType2
gallery3#galleryType1

注意。アプリケーションがアイドル状態の場合(ユーザーは何もしません)、ギャラリーやtypes.infoファイルはありません... 今、私はこのpoor types.infoに関するdoxygenエントリを作成して、ファイルタブに表示されるようにしたいと思います。 @verbincludeは動作しません:( 私は@packageタグを追加しましたが、これは回避策かもしれませんが、このファイルがdocページのFilesタブに文書化されていれば、本当にうれしいでしょう... はっきり? :)

1
私はあなたが何を達成しようとしているのかは分かりませんが、おそらく\ verbincludeはtxtファイルをコメントブロックに追加するのに役立ちます。
追加された 著者 doxygen,
私は問題を理解するのに苦労しています。もっと詳細を含めることができますか?ファイルとスニペットの例と、必要な出力
追加された 著者 Clare Macrae,

1 答え

ドキュメントブロック内の @file 属性でこれを実現することができます。

/**
 * @file project/data/gallery/types.info
 * Documentation for types.info in project/data/gallery/.
 */

これを有効にするには、有効なdoxygen入力ファイル名として types.info を追加する必要があります( INPUT および FILE_PATTERNS doxygen設定属性にはそれが含まれます)、ファイルが存在していなければなりません(しかし空でもかまいません)。

私がこのアプローチで見つけた主な注意点は、Pythonスタイルのdoxygenコメントではうまくいかないようです。

## @file project/data/gallery/types.info
# Documentation for types.info in project/data/gallery/.

C/C ++スタイルのコメントを含むことができるソースファイルが必要で、そのファイルもファイルタブの下に表示されます。

0
追加された