2016-07-13 8 views
1

Мне интересно, есть ли возможность повторно использовать описание заголовка файла doxygen для описания модуля.Использование заголовка файла doxygen в качестве описания модуля

/** 
    \file    
    \brief   Some brief info 
    \details  more Details 
*/ 
/** 
    \defgroup Views 
    \brief (Same as header doxy) 
    \details (Same as header doxy) 
*/ 

Чтобы избежать избыточности, я не буду копировать текст. Если переместить defgroup в начало файла, я получаю только имя файла, упомянутое в модуле, а не описание. Я пробовал уже некоторые комбинации, но я никогда не достигал своей цели. Детали и краткие тексты находятся либо в документации модуля, либо в документации к файлу. У кого-нибудь есть другая идея, как повторно использовать текст?

Большое спасибо,

Jonny

ответ

1

Я нашел решение сам. Вы можете использовать команду doxy @copydoc для копирования документации.

Мой код test.h выглядит следующим образом:

/** 
    \file   test.h 
    \brief   Some brief info 
    \details  more Details 
*/ 
/** 
    \defgroup Views 
    @copydoc view.h 
*/