Как заставить Qt Creator отображать всплывающие документы о моих функциях так же, как и для функций из библиотеки Qt?

Когда вы поместите указатель мыши на любую функцию/класс Qt, вы увидите всплывающее окно с кратким описанием того, что оно делает, взятое из документов в комментарии выше функции/класса.

Для моих функций/классов у меня есть документация в формате doxygen:

/**
  Returns foo
*/
QString getFoo() {
  return "foo";
}

Когда эта функция используется, я хочу просмотреть всплывающее окно того же типа с моими документами, когда указатель мыши находится над именем функции.

Можно ли сделать это с помощью Qt Creator?

Ответы

Ответ 1

К сожалению, для Qt Creator (как и в случае с выпуском версии 2.4) невозможно получить теги "на лету". Однако, что может работать, это позволить doxygen run и сказать, что он создает qch файлы. Если вы зарегистрируете созданный qch файл, вы должны получить мышь и даже правильный файл справки. См. http://www.ogre3d.org/tikiwiki/Integrating+API+documentation+into+Qt+Creator+Help для того, как это делает Ogre3D. YMMV, если это того стоит для быстро меняющегося проекта. Это, безусловно, хорошая идея для (полу) стабильной библиотеки.

Соответствующий отчет об ошибке: https://bugreports.qt.io/browse/QTCREATORBUG-4557

Ответ 2

Qt Creator требует, чтобы сгенерированные документы имели некоторые специальные маркеры для извлечения текста всплывающей подсказки. Я не мог найти способ вставить эти маркеры с Doxygen, поэтому я создал простой script, чтобы сделать это:

https://github.com/mmmarcos/doxygen2qtcreator

Это не пуленепробиваемый, но позволяет интегрировать наши классы и методы в подсказки Qt Creator.