LINUX.ORG.RU

Doxygen константа для документации

 ,


0

2

Возможно ли в doxygen задать какую-то константу, к примеру url где располагается другая документация.
К примеру есть такое описание метода:

/**
     * \brief Подтвердить ввод данных
     *
     * \details
     * Всегда серверу отправляется параметр `key` в котором должен храниться защитный ключ для проверки.
     *
     * * Для активации аккаунта отправляется запрос [/api/user/activate/](http://e2dit.com/apidoc/index.html#api-User-RecoveryPasswordUser)
     * * Для обновления телефона отправляется запрос [/api/user/update-phone/](http://e2dit.com/apidoc/index.html#api-User-RecoveryPasswordUser)
     * * Для восстановления отправляется запрос [/api/user/recovery-password/](http://e2dit.com/apidoc/index.html#api-User-RecoveryPasswordUser)
     */

и вместо http://e2dit.com/apidoc/index.html хотелось бы чтобы была объявлена в одном месте константа, и уже на нее ссылаться.

★★★

Doxygen умеет раскрывать в комментах переменные окружения. Например, загоняешь свой url в $MY_URL, а в комменте пишешь [/api..]($(MY_URL)#...)

E ★★★
()
Ответ на: комментарий от Int64

Да, my bad, я не проверил перед ответом, парсер doxygen'а не раскрывает переменные в ссылках.

Есть ещё вариант с INPUT_FILTER в Doxyfile:

INPUT_FILTER  = "sed -e 's/MY_URL/http.../'"

* * Для восстановления отправляется запрос [/api/user/recovery-password/](MY_URL#api-User-RecoveryPasswordUser)   
E ★★★
()
Ответ на: комментарий от E

Большое спасибо, все заработало :))

Int64 ★★★
() автор топика
Вы не можете добавлять комментарии в эту тему. Тема перемещена в архив.