У меня есть простой вопрос, который я не мог найти, копаясь в Google.
Я переношу документацию своего проекта из phpDoc в Doxygen, но не знаю, как написать @license и @copyright вместе.
По моему мнению, @copyright предназначено для названия моей "компании" (еще не настоящего :P), а @license способ, которым я разрабатываю, может быть использован: одна из многих комбинаций CreativeCommons, GNU, MIT, BSD, "по лицензии"...
Основываясь на ответе Криса, вы можете использовать команду \par для создания блока, аналогичного встроенной команде \copyright. Например, такой псевдоним:
ALIASES += "license=@par License:\n"
Разрешит этот комментарий:
/** My main function.
\copyright Copyright 2012 Chris Enterprises. All rights reserved.
\license This project is released under the GNU Public License.
*/
int main(void){
return 0;
}
для создания этого вывода:
Обратите внимание, что в этом решении пустая строка перед \license не требуется, а синтаксис {} не требуется. Это также с меньшей вероятностью вызовет проблемы, если вы попытаетесь создать документацию для форматов, отличных от HTML.
Хотя я согласен с вашим различием между информацией об авторских правах и лицензии, кажется, что doxygen не предлагает для них отдельных команд. Фактически, из документации по \author команда команда \copyright используется для указать информацию о лицензии.
Есть (по крайней мере) две возможные вещи, которые вы можете сделать здесь:
Просто объедините информацию об авторских правах и лицензии в аргументе команды \copyright:
/** My main function.
\copyright Copyright 2012 Chris Enterprises. All rights reserved.
This project is released under the GNU Public License.
*/
int main(void){
return 0;
}
Это генерирует HTML
Это почти наверняка самое простое, что вы можете сделать.
В качестве альтернативы, HTML-код, написанный для создания приведенного выше изображения,
<dl class="section copyright"><dt>Copyright</dt><dd>Copyright 2012 Chris Enterprises. All rights reserved. This project is released under the GNU Public License. </dd></dl>
Мы можем использовать это, чтобы определить новую команду, скажем, license, которая ведет себя аналогично команде copyright. Размещение следующего в поле ALIASES файла конфигурации doxygen
ALIASES += license{1}="<dl class=\"section copyright\"><dt>License</dt><dd>\1 </dd></dl>"
и изменив вышеуказанный блок документации на
/** My main function.
\copyright Copyright 2012 Chris Enterprises. All rights reserved.
\license{This project is released under the GNU Public License.}
*/
мы получаем сгенерированный doxygen вывод
Обратите внимание, что во втором решении есть пара особенностей: перед командой \license{...} должна быть пустая строка, а команда \license должна заключать аргумент в фигурные скобки. При желании вы можете сделать это с помощью команды \copyright, но команды с аргументами, определенными с помощью ALIASES, должны иметь фигурные скобки.
