Doxygenでtxtファイルを文書化しています

Question

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

問題は、私は1つのコードファイル内の2つのファイルをDOXことができないこと、である

はあなたを行います（ - - STD doxyconfがそれを許可していないか、少なくともそのマイナーまたは存在しないファイルのためのドキュメントが生成されません）それを克服する方法を知っていますか？ confの具体的な調整は何をすべきか？あるいは、コメント（文書）のみを含む.pyファイル（問題のファイルと同じディレクトリ）を作成する必要がありますか？

ありがとうございます。

編集。それをもっと明確にしよう。私は、次のファイルに自分のコードを持って言う：

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

実行している場合、アプリはいくつかのディレクトリを生成：にGallery1で

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

、我々はGallery2の中で、3枚のJPGのみと3xmlsを持っている - 1枚のjpgを、gallery3- 5xJPG & 5xXML。すべてがユーザーによってアップロードされます。

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

このファイルは、形式で情報が含まれています：

gallery1#galleryType1 
gallery2#galleryType2 
gallery3#galleryType1 

注ギャラリー1として 、2 & 3は、これらのdirsを作成した後、我々はまた、ファイルを作成し、少し異なる用法を持っています。アプリケーションがアイドル状態の場合（ユーザーは何もしません）、ギャラリーはなく、types.infoファイルはありません... 今、このpoor types.infoに関するdoxygenエントリを作成して、ファイルタブをクリックします。 @verbincludeは動作しません:( @packageタグを追加しましたが、回避策があるかもしれませんが、このファイルがドキュメントページの[ファイル]タブに記録されていれば、本当にいいと思います... あなたは、ドキュメントブロックで@file属性を持つようなもの、これを達成することができるかもしれない

Answer 1

：これが動作するためには

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

を、あなたはまた、有効なdoxygenを入力としてtypes.infoを追加する必要がありますファイル名（INPUTとFILE_PATTERNSのdoxygen構成属性にそれが含まれていることを確認します）と、fil eは存在していなければなりません（しかし空でもかまいません）。

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

あなたがC/C++スタイルのコメントを含めることができ、ソースファイルを持っている必要があります：

私は、このアプローチで見つかった主な注意点は、Pythonのスタイルdoxygenのコメントでは動作していないようだということですそのファイルは[ファイル]タブにも表示されます。