Документация для спокойных комментариев для документации? QT + Doxygen? [закрытый]
4 ответа
Не используйте qdoc. Он устарел. Используйте Doxygen, который в любом случае основан на qdoc.
Тем не менее, документация (в формате qdoc :-D ) находится здесь.
Вы можете посмотреть в самом исходном коде Qt для комментариев документации Qt ...
Я использовал DOxygen для документации, и для меня он работает нормально, хотя стандарты документации не принадлежат Qt. Я предлагаю вам попробовать и решить.
Использование doxygen для создания документации
Он может генерировать онлайновый браузер документации (в HTML) и/или автономное справочное руководство (LaTeX) из набора документированных исходных файлов. Также имеется поддержка генерации выходных данных в RTF (MS-Word), PostScript, PDF с гиперссылками, сжатый HTML и Unix man pages. Документация извлекается непосредственно из исходных текстов, что значительно облегчает согласование документации с исходным кодом.
Вы можете настроить doxygen на извлечение структуры кода из недокументированных исходных файлов. Это очень полезно для быстрого поиска информации в больших дистрибутивах исходных текстов. Вы также можете визуализировать отношения между различными элементами с помощью графов зависимостей, диаграмм наследования и диаграмм сотрудничества, которые генерируются автоматически.
Есть две части doxygen, которые специфичны для qt : Стиль комментариев Qt и тег конфигурации QT_AUTOBRIEF Doxyfile. Это просто части doxygen, которые используются QT. Все комментарии doxygen, используемые QT, являются обычным doxygen. Так что вам просто нужно прочитать о doxygen.
Или, возможно, вы действительно ищете документацию по внутреннему устройству QT, например информацию о d-указателях, содержащуюся в этой записи блога
Комментарии к стилю Qt:
/ *! Текстовый * / стиль комментариев называется "стилем Qt" комментариев doxygen.! помечает весь блок комментариев как блок комментариев doxygen. Это стандартная необязательная часть doxygen.
Параметр QT_AUTOBRIEF: если тег "QT_AUTOBRIEF" установлен в значение TRUE в Doxyfile, первая строка блока комментариев стиля Qt автоматически интерпретируется как \ краткое описание.
Из справки графического интерфейса пользователя doygen:
Для тега QT_AUTOBRIEF задано значение YES тогда doxygen интерпретирует первый линия (до первой точки) Комментарий в стиле Qt как краткое описание. Если установлено NO, комментарии будут вести себя как обычные Комментарии в стиле Qt (таким образом, требуя явная \ краткая команда для краткого описание.)