Есть ли эквивалент @inheritDoc в Doxygen? - PullRequest
14 голосов
/ 04 апреля 2011

Я знаю, что Javadoc скомпилирует {@inheritDoc}, но как это сделать с помощью Doxygen?

Ответы [ 2 ]

13 голосов
/ 10 апреля 2011

Существует явный copydoc , который, я думаю, наиболее близок к эквиваленту, хотя, с большей гибкостью, он требует от вас указания оригинала для копирования, что немного более неудобно. Он предназначен для того, чтобы вы могли получать документацию из в любом месте , поэтому для него требуется параметр, указывающий источник.

По умолчанию , по умолчанию наследуется документация от родительских классов.

11 голосов
/ 21 марта 2015

Если для INHERIT_DOCS задано значение YES в файле конфигурации Doxygen (что на самом деле используется по умолчанию), просто оставьте переопределенные члены полностью незакомментированными и Doxygen автоматически вставит документацию из базыclass.

@ copydoc полезно для случая, когда вы хотите наследовать комментарии базового класса, но затем добавить некоторые специфичные для подкласса детали.

...