Используя автоматическую документацию моей собственной функции с Qt Creator?

Я использовал Qt Creator, и решил, что хочу записать функцию, которую я написал, поэтому я поставил курсор над моим определением функции и набрал /**<ENTER> следующим образом:

/**<ENTER>
void MyClass::myFunction(int myArg)
{
...

Qt Creator автоматически расширил этот комментарий:

/**
 * @brief MyClass::myFunction
 * @param myArg
 */
void MyClass::myFunction(int myArg)
{
...

Что это? Где это задокументировано?

Могу ли я использовать это для создания собственных файлов справки Qt Assistant qch или что-то еще?

Ответы

Ответ 1

Здесь следует документировать здесь или здесь, но его не...

Итак, вот некоторая информация об этом:

Настройки этой функции можно найти здесь:

Окна:

Создатель Qt > Инструменты > Параметры > Текстовый редактоp > Завершение > Комментарии к документации

Mac OS X:

Создатель Qt > Предпочтения > Текстовый редактоp > Завершение > Комментарии к документации

Три следующих параметра:

  • Включить блоки Doxygen
  • Создание краткого описания
  • Добавление звездочек

(найдено в Qt 2.6, но, возможно, в более ранних версиях тоже?, или он может быть частью набора плагинов по умолчанию в какой-то момент.)

Созданные заглушки - это заглушки стиля Doxygen.

Вы можете использовать doxygen для запуска вашего исходного кода и создания некоторой причудливой документации, как в файле chm, так и в html-документе и pdf.

http://www.stack.nl/~dimitri/doxygen/

http://www.stack.nl/~dimitri/doxygen/manual/output.html (включает qch файлы)

Вот родственный плагин для Qt Creator:

http://dev.kofee.org/projects/qtcreator-doxygen/wiki

И используя QHelpEngine в вашей собственной программе...

http://qt-project.org/doc/qt-4.8/qthelp-framework.html

И, наконец, вы можете использовать QDesktopServices для обработки URL-адреса, созданного с помощью справки:

http://doc-snapshot.qt-project.org/4.8/qdesktopservices.html#url-handlers

Надеюсь, что это поможет.