Документирование функций в C ++ с помощью Doxygen [closed]
Попробуйте поместить document.getElementById в setTimeout()
Например.
setTimeout(function(){
console.log(document.getElementById('whatever'));
}, 100);
Если это сработает, тогда это просто проблема синхронизации.
4 ответа
Используйте \fn там, где вы иначе используете \class в вашем \\\*! *\ block
http://www.doxygen.nl/manual/docblocks.html
http://www.doxygen.nl/manual/commands.html#cmdfn
Ищите "Документация в других местах"
http://www.doxygen.nl/manual/commands.html#cmdfn
Это работает аналогично документированию функций-членов
Сущности, являющиеся членами классов, документируются только в том случае, если их класс задокументирован. Объекты, объявленные в области пространства имен, документируются только в том случае, если их пространство имен задокументировано. Объекты, объявленные в области видимости файла, документируются только в том случае, если их файл задокументирован.
Таким образом, чтобы документировать свободную функцию в глобальном пространстве имен, вам также понадобится строка вроде этой где-то в заголовочном файле, в которой она объявлена:
/** @file */
Или так:
/*! \file */
Мне нравится этот шаблон
///////////////////////////////////////////////////////////////////////
/// \brief setX
/// \param x offset of the image.
/// \return a new image as an QImage.
/////////////////////////////////////////////////////////////////////////
QImage setX(int x);
Этот шаблон хорошо сработал для нас.
/*! Convert counts to kg for the reservoir.
\param counts The A/D counts to convert.`
\return The calculated kg based on the parameter.
*/
float RES_ConvertCountsToValue(uint_16 counts);