Принудительная документация по функциям в Doxygen для документирования JavaScript API - PullRequest
3 голосов
/ 19 января 2011

Я использую Doxygen для документирования JavaScript API моего проекта C ++ (Qt). Идея состоит в том, чтобы написать одну конкретную документацию для интерфейсов JavaScript, а другую - для обычных классов C ++. Один пример (datasource.dox) выглядит так:

\addtogroup JavaScriptAPI
@{
...
\class DataSource
\brief DataSource is the .... some doc goes here ....

\section formats Supported formats
....

\fn isOpen()
\brief returns true if the data source is currently open...
...
@}

Сгенерированная справка выглядит хорошо w.r.t. описание класса (или «описание объекта»), но документация по функции (isOpen (), ...) отсутствует. Doxygen создает предупреждающие сообщения, такие как: Предупреждение: документированная функция `bool isOpen 'не была объявлена ​​или определена.

Теперь вопрос: могу ли я каким-то образом заставить doxygen использовать мои описания функций \ fn-d? Было бы хорошо, если бы doxygen создал все эти индексы для меня ...

1 Ответ

0 голосов
/ 24 ноября 2011

Два подхода к использованию doxygen с Javascript перечислены здесь http://www.doxygen.org/helpers.html (ищите JavaScript)

...