Как контролировать порядок документирования разделов документации? - PullRequest
8 голосов
/ 27 сентября 2010

Я добавил свою документацию следующим образом: краткое описание, параметры и возвращаемое значение объясняются в заголовке, подробности о реализации объясняются в источнике.

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

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

1 Ответ

3 голосов
/ 12 октября 2010

Создайте, а затем настройте файл layout.xml.Для получения дополнительной информации см. эту страницу на сайте Doxygen .

...