Как сказать doxygen использовать / ** в качестве класса документа вместо / *! \учебный класс - PullRequest
Новая
       1

Как сказать doxygen использовать / ** в качестве класса документа вместо / *! \учебный класс

1 голос
/ 06 июня 2011

Я пытаюсь переключиться с phpDocumentor на doxygen, но все мои классы задокументированы в следующем стиле: 

/**
 * DESCRIPTION
 *
 * @category  PHP
 * @package   UserManagement.Class
 * @author    Name <email@company.com>
 * @copyright 2011 Company
 * @link      http://www.company.com
 */

, но doxygen не распознает это как doc класса, если я не изменю первую строкуto 

/*! \class CLASSNAME

Есть ли способ сказать doxygen, чтобы использовать стиль "/ **"?

regards

Ответы [ 3 ]

2 голосов
/ 08 июня 2011

Я нашел проблему (но не реальное решение): Doxygen не нравится @category & @package в блоке класса doc. Если я удаляю их, это работает.

2 голосов
/ 06 июня 2011

Doxygen должен распознавать комментарии JavaDoc (т.е. / **).Возможно, проблема в том, что ваше краткое описание не определяется автоматически.

Чтобы заставить Doxygen использовать эти короткие описания, вам нужно установить JAVADOC_AUTOBRIEF в YES в вашем конфигурационном файле.

Подробнее о стиле документации Doxygen на этот

1 голос
/ 26 июля 2013

Если, например, ваши коллеги по-прежнему используют phpDoc, вы можете использовать конфигурацию INPUT_FILTER для фильтрации нежелательных тегов: 

$ grep INPUT_FILTER doc/doxygen.config
INPUT_FILTER      = /home/gorgo/someproj/doc/doxygen.inputfilter

Сценарий inputfilter должен быть исполняемым, и его содержимое может быть примерно таким:: 

$ cat doc/doxygen.inputfilter
#!/bin/sh

grep -Fv '@package' $1 | grep -Fv '@category'
...