Применение системы документирования исходных текстов Doxygen

@soican · Регистрация: 16.11.2011

решил узнать о такой штуке и как она работает,
выбрал исходник, но что-то не получаю своих комментариев! как-то получилось "получить" названия своих классов, структур и что в них, а комментарии никак не вынесены!

@0x10 · 18.07.2013, 18:52

soican, комменты оформлены в соответствии с одним из форматов, понимаемых doxygen?

@soican · 18.07.2013, 19:54 **[ТС]**

Сообщение от 0x10

в соответствии с одним из форматов, понимаемых doxygen?

ну примерно так

C++

1
2
3

//масссив структур, определяющий все значащие элементы ГМЖ и их индексы.
//3*NN dimensions of Global Matrix
T_GSM_element *GSM = new  T_GSM_element [3*NN];

я что-то не пойму, что сюда писать: я писал папку, где exe

@0x10 · 18.07.2013, 20:03

По идее рабочая директория - та, от которой искать исходники.

Добавлено через 57 секунд
Такие комментарии и не должен подхватывать, читай документацию. http://www.stack.nl/~dimitri/d... ecialblock

@soican · 18.07.2013, 20:56 **[ТС]**

Сообщение от 0x10

По идее рабочая директория - та, от которой искать исходники.

смотри, вот чего я не пойму

@0x10 · 18.07.2013, 21:06

Офигеть, у него есть gui)
Он у меня не очень быстро ставится, поэтому пока могу максимум прочитать надписи. Верхняя - каталог, где будет запущен doxygen. Может он там конфиг ищет, хз. Второе - ок, похоже на каталог с исходниками.
В любом случае, html с классами-то на выходе есть, проблема в комментах.

@itia · 27.02.2015, 21:16

всем привет.
помогите плиз... настройки doxygen...
не получается настроить doxygen так чтобы блок с подробным описанием класса, включался в описание самого модуля ну или файла... не знаю как правильно выразится... (
"Он" мне описывает класс в начале документации сразу после оглавления и описывает его как "структуру данных", документация о нем выводится не в описании самого файла внутри где он объявляется , а до описания файла.срр и файла.h
заранее прошу прощения если не верно выразилась. В программировании почти не разбираюсь , начинаю с документирования кода. ))
хотелось бы разобраться в doxygen.
Заранее спасибо за ответы.

@Nick Alte · 28.02.2015, 13:11

В Doxygen есть специальные команды, @brief и @details. Первая задаёт краткое описание, которое пишется во всяческих списках и т.п., вторая развёрнутое.

C++

//! @brief Это структура для хранения имени файла.
struct FileName {
    std::string path;  //!< @brief Путь к файлу.
    std::string name;   //!< @brief Имя файла.
    std::string extension;   //!< @brief Расширение файла.
};

@itia · 01.03.2015, 23:44

добрый вечер.
Спасибо что ответили...
а можно по подробнее, если вас не затруднит...
запускаю doxywizard, расставляю галочки где необходимо....
Кроме этого ... !нужно ли в самих файлах.... файл.срр и в файл.h прописывать эти команды? о которых вы говорите (т.е. открыть их notepad-ом и вписать эти команды в начале кода или перед объявлением класса?) правильно ли я поняла... или достаточно проставить в нужных местах галки...
Вроде проставляю, а он мне все равно описание классов ставит перед описанием всего кода где эти классы обьявленны (используются...) а в самом описании файла.h и .срр только упоминает об нем (в документации прописывается только имя и все)

мне очень неудобно за глупые вопросы .... но мы все когда-то начинаем с нуля
прошу прощения за глупые вопросы....

заранее благодарю за ответ.

@Nick Alte · 02.03.2015, 22:02

Прописывать команды, естественно, нужно, и именно непосредственно перед объявлением класса или структуры. В некоторых случаях можно после, но тогда с символом <, как у меня в примере.

@itia · 02.03.2015, 22:31

большое СПАСИБО!

@itia · 27.06.2015, 10:28

Всем привет!
Ребята, есть такая задача:
есть .cpp и .h файлы.
В .h файлах функции объявлены и в .cpp файлах они описаны.
Задача в том, что при запуске Doxywizard генерирует документацию в формате RTF,
функции класса не отображаются в документации в описании файла .h в документации RTF, а отображаются на отдельной странице в начале документации в разделе «краткое описание классов".
Что я могу сделать (как документировать .h файл и какую конфигурацию я должна указать в Doxywizard), чтобы исключить этот раздел "Краткое описание классов" в начале документации, а также отобразить (в документации) в описании .h файла, класс вместе с его функциями. (на данный момент в документации RTF в том месте где описывается .h файл - указывается само название xx.h файла перечисляются и описываются переменные а так же enum-перечисления, и указывается что есть класс, но вот все функции этого класса и его конструктор и десструктор ) все документируются в начале документации после содержания в разделе "краткое описание классов"
пробовала разные комбинации опций в Doxywizard чтоб убрать краткое описание и вставить это описание в нужное место в документировании .h файла... но на раздел "краткое описание классов " это ни как ни влияет

.
Может кто с этим конкретно сталкивался ... уже пол года с этим мучаюсь все никак не получается.
пока просто приходится RTF документ в ручную его структурировать , вырывать описание классов с функциями с одного места и вставлять в уже в то место где документируется .h файл.
Ранее я здесь спрашивала об этом же, но наверное я не верно объяснила.

Я надеюсь, что я правильно все объяснила.
Заранее большое спасибо всем.

@sourcerer · 27.06.2015, 10:43

itia, может тут что-то найдёшь.

@itia · 27.06.2015, 11:25

Я уже облазила все что можно, этот сайт habrahabr и сам сайт doxygenа были первые ...везде примеры по выводу документации в HTML формате, не в RTF и даже там, классы появляются в отдельной вкладке под названием "классы" , а мне нужно чтоб они были в .h файле, то есть если это даже бы и был пример для HTML, то там должно было бы быть документирование классов с их методами в самой вкладке под названием "Файл", как то их бы сгруппировать... но я уже пробовала и группировать... ничего..

но в любом случае спасибо...
буду эти сайты еще раз перечитывать...
но если у кого есть еще идейки или ... ткнуть меня носом прям в нужную информацию ... ну прямо... очень была бы благодарна ..... а то классов очень много в проекте и .h файлов тоже много ... )))) приходиться деребанитть RTF документ на кусочки ))))) несколько дней... а то и недель )))
Спасибо.

@sourcerer · 27.06.2015, 12:10

itia, там внизу статьи есть полезные ссылки:

Литература и ссылки для дальнейшего изучения

1. Основным источником, который был использован при написании статьи была официальная документация;
2. На большое количество вопросов, связанных с Doxygen, ответы были получены здесь (там есть и создатель Doxygen).

Добавлено через 38 секунд
Можно просто задать вопрос создателю Doxygen, если тут никто не подскажет.

Добавлено через 5 минут
Собственно, можно там же на хабре дополнительно спросить (см. прямо под статьёй комментарии).

@itia · 27.06.2015, 12:51

уже отправила вопрос Дмитрию кажется но в bugzill-у понимаю что не по адресу ,но письмо которое отправляла непосредственно на адрес doxygen-users@lists.sourceforge.net вернулось назад maildelivery... пишут что не верный адрес, буду пробовать еще ...
+ еще ищу информацию именно на http://sourceforge.net/p/doxyg... 94/?page=1
и на http://doxygen.10944.n7.nabble... ction&i=12
и еще вот здесь http://stackoverflow.com/
только там все на английском и ....)))) короче пока из того что поняла не нашла ничего что мне нужно и вот подумала может.. здесь на сайте получится
на хабрахабр только что зарегистрировалась, буду их спрашивать.
Спасибо.

@itia 0 / 0 / 0 Регистрация: 27.02.2015 Сообщений: 6
	27.06.2015, 11:25	14
	Я уже облазила все что можно, этот сайт habrahabr и сам сайт doxygenа были первые ...везде примеры по выводу документации в HTML формате, не в RTF и даже там, классы появляются в отдельной вкладке под названием "классы" , а мне нужно чтоб они были в .h файле, то есть если это даже бы и был пример для HTML, то там должно было бы быть документирование классов с их методами в самой вкладке под названием "Файл", как то их бы сгруппировать... но я уже пробовала и группировать... ничего.. но в любом случае спасибо... буду эти сайты еще раз перечитывать... но если у кого есть еще идейки или ... ткнуть меня носом прям в нужную информацию ... ну прямо... очень была бы благодарна ..... а то классов очень много в проекте и .h файлов тоже много ... )))) приходиться деребанитть RTF документ на кусочки ))))) несколько дней... а то и недель ))) Спасибо. 0

@soican 49 / 23 / 3 Регистрация: 16.11.2011 Сообщений: 329 Записей в блоге: 5
		1
	Применение системы документирования исходных текстов Doxygen 18.07.2013, 18:50. Просмотров 2561. Ответов 15 Метки нет (Все метки) решил узнать о такой штуке и как она работает, выбрал исходник, но что-то не получаю своих комментариев! как-то получилось "получить" названия своих классов, структур и что в них, а комментарии никак не вынесены! 0 Миниатюры

@0x10 3238 / 2046 / 350 Регистрация: 24.11.2012 Сообщений: 4,895
	18.07.2013, 18:52	2
	soican, комменты оформлены в соответствии с одним из форматов, понимаемых doxygen? 0

@0x10 3238 / 2046 / 350 Регистрация: 24.11.2012 Сообщений: 4,895
	18.07.2013, 20:03	4
	По идее рабочая директория - та, от которой искать исходники. Добавлено через 57 секунд Такие комментарии и не должен подхватывать, читай документацию. http://www.stack.nl/~dimitri/d... ecialblock 1

@soican 49 / 23 / 3 Регистрация: 16.11.2011 Сообщений: 329 Записей в блоге: 5
	18.07.2013, 20:56 [ТС]	5
	Сообщение от 0x10 По идее рабочая директория - та, от которой искать исходники. смотри, вот чего я не пойму 0 Миниатюры

@0x10 3238 / 2046 / 350 Регистрация: 24.11.2012 Сообщений: 4,895
	18.07.2013, 21:06	6
	Офигеть, у него есть gui) Он у меня не очень быстро ставится, поэтому пока могу максимум прочитать надписи. Верхняя - каталог, где будет запущен doxygen. Может он там конфиг ищет, хз. Второе - ок, похоже на каталог с исходниками. В любом случае, html с классами-то на выходе есть, проблема в комментах. 0

@itia 0 / 0 / 0 Регистрация: 27.02.2015 Сообщений: 6
	27.02.2015, 21:16	7
	всем привет. помогите плиз... настройки doxygen... не получается настроить doxygen так чтобы блок с подробным описанием класса, включался в описание самого модуля ну или файла... не знаю как правильно выразится... ( "Он" мне описывает класс в начале документации сразу после оглавления и описывает его как "структуру данных", документация о нем выводится не в описании самого файла внутри где он объявляется , а до описания файла.срр и файла.h заранее прошу прощения если не верно выразилась. В программировании почти не разбираюсь , начинаю с документирования кода. )) хотелось бы разобраться в doxygen. Заранее спасибо за ответы. 0

@itia 0 / 0 / 0 Регистрация: 27.02.2015 Сообщений: 6
	01.03.2015, 23:44	9
	добрый вечер. Спасибо что ответили... а можно по подробнее, если вас не затруднит... запускаю doxywizard, расставляю галочки где необходимо.... Кроме этого ... !нужно ли в самих файлах.... файл.срр и в файл.h прописывать эти команды? о которых вы говорите (т.е. открыть их notepad-ом и вписать эти команды в начале кода или перед объявлением класса?) правильно ли я поняла... или достаточно проставить в нужных местах галки... Вроде проставляю, а он мне все равно описание классов ставит перед описанием всего кода где эти классы обьявленны (используются...) а в самом описании файла.h и .срр только упоминает об нем (в документации прописывается только имя и все) мне очень неудобно за глупые вопросы .... но мы все когда-то начинаем с нуля прошу прощения за глупые вопросы.... заранее благодарю за ответ. 0

@Nick Alte 1661 / 1033 / 174 Регистрация: 27.09.2009 Сообщений: 1,945
	02.03.2015, 22:02	10
	Прописывать команды, естественно, нужно, и именно непосредственно перед объявлением класса или структуры. В некоторых случаях можно после, но тогда с символом <, как у меня в примере. 0

@itia 0 / 0 / 0 Регистрация: 27.02.2015 Сообщений: 6
	02.03.2015, 22:31	11
	большое СПАСИБО! 0

@itia 0 / 0 / 0 Регистрация: 27.02.2015 Сообщений: 6
	27.06.2015, 10:28	12
	Всем привет! Ребята, есть такая задача: есть .cpp и .h файлы. В .h файлах функции объявлены и в .cpp файлах они описаны. Задача в том, что при запуске Doxywizard генерирует документацию в формате RTF, функции класса не отображаются в документации в описании файла .h в документации RTF, а отображаются на отдельной странице в начале документации в разделе «краткое описание классов". Что я могу сделать (как документировать .h файл и какую конфигурацию я должна указать в Doxywizard), чтобы исключить этот раздел "Краткое описание классов" в начале документации, а также отобразить (в документации) в описании .h файла, класс вместе с его функциями. (на данный момент в документации RTF в том месте где описывается .h файл - указывается само название xx.h файла перечисляются и описываются переменные а так же enum-перечисления, и указывается что есть класс, но вот все функции этого класса и его конструктор и десструктор ) все документируются в начале документации после содержания в разделе "краткое описание классов" пробовала разные комбинации опций в Doxywizard чтоб убрать краткое описание и вставить это описание в нужное место в документировании .h файла... но на раздел "краткое описание классов " это ни как ни влияет . Может кто с этим конкретно сталкивался ... уже пол года с этим мучаюсь все никак не получается. пока просто приходится RTF документ в ручную его структурировать , вырывать описание классов с функциями с одного места и вставлять в уже в то место где документируется .h файл. Ранее я здесь спрашивала об этом же, но наверное я не верно объяснила. Я надеюсь, что я правильно все объяснила. Заранее большое спасибо всем. 0

Опции темы

@sourcerer 5044 / 2227 / 330 Регистрация: 20.02.2013 Сообщений: 5,600 Записей в блоге: 24
	27.06.2015, 10:43	13
	itia, может тут что-то найдёшь. 0

@sourcerer 5044 / 2227 / 330 Регистрация: 20.02.2013 Сообщений: 5,600 Записей в блоге: 24
	27.06.2015, 12:10	15
	itia, там внизу статьи есть полезные ссылки: Литература и ссылки для дальнейшего изучения 1. Основным источником, который был использован при написании статьи была официальная документация; 2. На большое количество вопросов, связанных с Doxygen, ответы были получены здесь (там есть и создатель Doxygen). Добавлено через 38 секунд Можно просто задать вопрос создателю Doxygen, если тут никто не подскажет. Добавлено через 5 минут Собственно, можно там же на хабре дополнительно спросить (см. прямо под статьёй комментарии). 0

@itia 0 / 0 / 0 Регистрация: 27.02.2015 Сообщений: 6
	27.06.2015, 12:51	16
	уже отправила вопрос Дмитрию кажется но в bugzill-у понимаю что не по адресу ,но письмо которое отправляла непосредственно на адрес doxygen-users@lists.sourceforge.net вернулось назад maildelivery... пишут что не верный адрес, буду пробовать еще ... + еще ищу информацию именно на http://sourceforge.net/p/doxyg... 94/?page=1 и на http://doxygen.10944.n7.nabble... ction&i=12 и еще вот здесь http://stackoverflow.com/ только там все на английском и ....)))) короче пока из того что поняла не нашла ничего что мне нужно и вот подумала может.. здесь на сайте получится на хабрахабр только что зарегистрировалась, буду их спрашивать. Спасибо. 0