2013-11-25 3 views
1

Я смог добавить пользовательские страницы в документацию doxygen даже с описанием (которое не документировано). Однако у меня есть это здесь:Как добавить описание устаревшего списка?

/*! 
* \page fielname Here comes the title 
* \brief A short introduction which explains this page. 
* 
* The real page content... 
*/ 

Это прекрасно работает, но как я добавить \brief (описание) для устаревшего списка? Теперь это выглядит недокументированной страницей, чего я хочу избежать.

+0

Могу ли я просто подтвердить, что вы хотите добавить введение на страницу _automatically generated_ по Doxygen из 'тегов \ deprecated'? – Cheeseminer

+0

@Cheeseminer, что тоже было бы круто, но я не хочу, чтобы на сгенерированном 'pages.html' добавлялось описание, например. * устаревший список * и все другие списки, такие как список дел и другие списки '\ xrefitem'. – rekire

ответ

1

Я думаю, что вы ищете может быть достигнуто следующее:

/** Test class 
* @deprecated Will be removed in release 2.0 
*/ 
class Test 
{ 
}; 

/** @page deprecated 
* @brief Deprecated page brief 
* 
* Deprecated page contents. 
*/ 
+0

Это большое спасибо! Какой-то небольшой вопрос, где я должен сообщать об одной ошибке? У меня есть класс с дженериками, который содержит вложенный статический класс даже с дженериками, не документируется с помощью doxygen. – rekire

+0

Сайт doxygen имеет ссылку на базу данных bugzilla, которую он использует для отчетов об ошибках. См. Http://www.stack.nl/~dimitri/doxygen/manual/trouble.html#bug_reports – Cheeseminer

Смежные вопросы