Как один документ документирует атрибуты класса, используя Doxygen?

Question

Я пытаюсь задокументировать атрибуты класса, используя Doxygen. В настоящее время защищенные атрибуты отображаются в списке вверху страницы для определенного класса. Я хотел бы дать им объяснение.

Я пытался использовать @param [name] [description] как над началом класса, так и над объявлением атрибутов. Я даже пытался поместить их в докблок для моего класса конструктора, и это просто сломало его.

Есть ли что-то, что я просто пропускаю?

- Логан

Answer 1

Вы должны использовать < или комментарий прямо перед атрибутом:

class cMainData
{
    private $attr;  //!< This is my attribute

    //! This is another attribute
    private $otherAttr;
}

Обратите внимание, что вы можете использовать @brief, @note и аналогичные, например:

class cMainData
{
    private $attr;  //!<@brief This is my attribute.
                    //!< This is some additional info about this attribute.
}

Answer 2

Я опубликовал обходной путь в ответ на дубликат этого вопроса: Doxygen: как описать переменные члена класса в php? Может быть полезно связать его отсюда для других, которым необходимо решение, совместимое со стилем аннотации phpDoc.