Документ произвольных отношений в Doxygen - PullRequest
0 голосов
/ 29 января 2020

Doxygen может найти и задокументировать структурные отношения в коде, например, член m является частью struct s, class child наследуется от class parent, et c, при анализе источника код, и сгенерированная документация отлично подходит для навигации по всему этому.

В исходном коде также есть другие отношения, которые я хотел бы записать и документировать как автор.

Например, если pthread_mutex M защищает глобальную переменную int var, я бы хотел, чтобы сгенерированная документация express указала это отношение.

Как объявить связь между M и var, с помощью аннотаций doxygen, чтобы добиться этого?

Добавление вручную @ref в каждую переменную do c неудовлетворительно, так как не масштабируется и не может поддерживаться.

См. эту функцию запрос всей истории:

https://github.com/doxygen/doxygen/issues/7517

Есть ли другой способ захвата произвольных отношений в источнике, который я мог бы использовать вместо этого?

...