Doxygen: нет гиперссылок, созданных для функций, не являющихся членами - PullRequest
0 голосов
/ 12 сентября 2018

Я использую Doxygen 1.8.14, в моей сгенерированной документации краткие описания функций-членов класса в верхней части каждого html-файла, соответствующего классу, и все упоминания таких функций в одном и том же html-документе указывают на полноеДокументация по функциям далее по странице с помощью гиперссылок.

Однако этого не происходит (в обоих случаях) для функций, которые не являются членами класса.

Мне кажется, что Doxygen не работает илитам что-то мне не хватает?Я считаю, что согласно документации это должно работать.

1 Ответ

0 голосов
/ 12 сентября 2018

Doxygen, в некоторой степени производный от JavaDoc, в некоторой степени ориентирован на классы. Таким образом, документированные элементы, которые не являются членами класса, должны быть членами что-то , чтобы они появлялись в документации.

Вы можете сделать их членами задокументированного файла (для этого необходимо документировать файл, в котором они появляются), документированного пространства имен или добавить их в существующий модуль / группу документации с помощью \addtogroup и аналогичных инструментов документирования. .

Это не обязательно плохо. Модули документации очень полезны для выделения связанных функций / классов. И документирование файлов и пространств имен также хорошо, так что пользователи могут видеть список того, что является частью каждого файла или пространства имен.

...