Doxygen ішіндегі txt файлдарын құжаттау

Мен Doxygen-ды Python жобасын құжаттау үшін қолданамын. Қолданба кейбір шағын txt файлдарын қолданады, мысалы: конфигурация туралы ақпарат, журналдар және т.б. Ашық себептер бойынша ешқандай Doxygen ақпараты тікелей осы файлдарға қосылмайды (бұл файлдар талдау мүмкін емес) - бұл құжатты басқа файлдарға (коды бар) жазу керек.

Мәселе мынада, бір код файлында dox 2 файлды алмаймын (немесе кем дегенде - std doxyconf рұқсат бермейді - бұл кәмелетке толмаған немесе жоқ файлдар үшін құжат жоқ)

Сіз оны қалай жеңуге болатынын білесіз бе? Конфептегі қандай нақты швед жасау керек? Немесе түсініктеме (құжаттама) бола алатын, .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

Ескерту. Егер қолданба бос болмаса (пайдаланушы ештеңе жасамайды), галереялар жоқ, түрлері жоқ. Енді файлдар қойындысында көрінетін етіп, осы кедей түрлері туралы doxygen жазбасы жасағыңыз келеді. @Verbinclude жұмыс істемейді :( @Package тегіне қосылдым және бұл уақытша шешім болуы мүмкін, бірақ бұл файлды doc беттің «Файлдар» қойындысында құжаттағанымда жақсы болар еді ... Ашық па? :)

1
Сіз не істеп жатқаныңызға сенімді емеспін, бірақ, \ verbinclude, txt файлдарын кейбір түсініктеме блогына қосу үшін көмектесуі мүмкін.
қосылды автор doxygen, көзі
Мәселені немесе қиындықты түсінуге тырысамын. Қосымша мәліметтерді қамтуы мүмкін, мысалы: Мысал файлдар мен үзінділер және қандай нәтиже қажет
қосылды автор Clare Macrae, көзі

1 жауаптар

Мұны @file төлсипатымен құжаттамалық блокта орындауға болады, мысалы:

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

Бұл жұмыс істеу үшін сіз сондай-ақ, types.info дегенді жарамды doxygen енгізу файлы атауымен ( INPUT және FILE_PATTERNS doxygen конфигурациясының атрибуттары болады) және файл бар болуы керек (бірақ бос болуы мүмкін).

Мен осы тәсілмен тапқан негізгі ескертпе мынада, бұл python стиліндегі doxygen түсініктемелерімен жұмыс істемейді:

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

C/C ++ мәнерінің түсініктемелерін қамтитын бастапқы файл болуы керек және бұл файл файлдар қойындысында көрсетіледі.

0
қосылды