Могу ли я сгенерировать обычную документацию, которая появится в отчете doxygen? - PullRequest
0 голосов
/ 23 октября 2019

Я только начал использовать doxygen для документирования некоторого унаследованного кода на C, и я очень впечатлен тем, что можно сделать даже с кодом без разметки. Я получил основы, аннотирующие подпрограммы: краткое описание, param, return, see и т. Д. Все это прекрасно выглядит в сгенерированной документации для функции. Мой вопрос: могу ли я поместить разметку doxygen в подпрограмму, вкрапленную в фактический код, чтобы комментарии, объясняющие «предстоящий» раздел кода, также могли быть включены в документацию. Предоставление пошагового обзора того, что делает функция без необходимости копировать эти комментарии в начало процедуры?

...