Doxygen'de txt dosyalarını belgeleme

Bir Python projesini belgelemek için Doxygen kullanıyorum. Uygulama, ör. yapılandırma bilgileri, günlükler vb. Açık nedenlerle, bu dosyalara doğrudan Doxygen bilgisi eklenemez (ayrıştırma ile ilgili sorunlar olabilir, bu dosyalar mevcut olmayabilir) - Bu belgeyi diğer dosyalara (kod içeren) yazmam gerekiyor.

Sorun şu ki, bir kod dosyasında 2 dosya yapamam (veya en azından - std doxyconf buna izin vermiyor - bu küçük veya var olmayan dosyalar için belge oluşturulmuyor)

Bunu nasıl aşacağını biliyor musun? Conf'ta hangi spesifik tweak yapılmalı? Ya da sadece yorum (belge) içerebilecek bir .py dosyası (söz konusu dosya ile aynı dir) oluşturmayı mı tercih edeyim?

Şimdiden teşekkürler.

Düzenle. Tamam, daha net yapmaya çalışıyorum. Kodumu aşağıdaki dosyalarda aldığımı söyle:

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

eğer çalışıyorsa, uygulama bazı dizinler oluşturur:

(...)/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

Bu dosya şu formatta bilgi içeriyor:

gallery1#galleryType1
gallery2#galleryType2
gallery3#galleryType1

Not. Uygulama boşta (kullanıcı bir şey yapmazsa), galeri yok ve types.info dosyası yok ... Şimdi, bu kötü types.info hakkında bir doxygen girişi oluşturmak istiyorum, böylece dosya sekmesinde görünecektir. @Verbinclude çalışmıyor :( @Package etiketini ekledim ve bu bir geçici çözüm olabilir, ancak bu dosyanın doc sayfasının Dosyalar sekmesinde belgelenmesi gerçekten hoş olurdu ... Daha net? :)

1
Neyi başarmaya çalıştığınızdan emin değilim, ancak belki de verbinclude, txt dosyalarını daha fazla açıklayan bazı yorum bloğuna dahil etmeye yardımcı olabilir.
katma yazar doxygen, kaynak
Sorunu ya da neyi başarmaya çalıştığını anlamaya çalışıyorum. Daha fazla ayrıntı ekleyebilir misiniz, ör. Örnek dosyalar ve snippet'ler ve istediğiniz çıktı
katma yazar Clare Macrae, kaynak

1 cevap

Bunu bir dokümantasyon bloğunda @file özniteliği ile gerçekleştirebilirsiniz, örneğin:

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

Bunun çalışması için, types.info kodunu geçerli bir doxygen giriş dosyası adı olarak eklemeniz gerekir ( INPUT ve FILE_PATTERNS > Doxygen konfigürasyon özellikleri bunu içerecektir) ve dosya mevcut olmalıdır (ancak boş olabilir).

Bu yaklaşımla bulduğum ana uyarı, python stili doxygen yorumları ile çalıştığı görünmüyor:

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

C/C ++ stili yorumlarını içerebilen bir kaynak dosyaya sahip olmanız gerekir ve bu dosya ayrıca dosyalar sekmesinde görünecektir.

0
katma