Doxygen — объявить параметр необязательным
Я документирую кодовую базу, используя Doxygen, и мне было интересно, есть ли ключевое слово для объявления аргумента функции необязательным. Что-то вроде:
/*!
\fn int add(int a, int b=0)
\brief adds two values
\param a the first operand
\param \optional b the second operand. Default is 0
\return the result
*/
Кажется, это то, что должно существовать, но я нигде не смог его найти. Есть ли актуальная опция или мне просто нужно сделать пометку в описании?
Решение
Чтобы ответить на ваш вопрос: нет, такого нет.
Но я не разделяю вашего мнения, что должно быть что-то подобное. В конце концов, объявление функции будет отображаться вместе с документацией, так что каждый может увидеть, что b не является обязательным, и что это аргумент по умолчанию. И для \fn см документацию doxygen препятствуя использованию \ fn.
Другие решения
То, что вы хотите, не предоставляется Doxygen — вам придется вручную сделать это в описании.