Doxygen и Visiblity Ключевые слова в PHP

Question

Я нахожу, что в PHP, если я делаю это:

class Foo{ 

    /** 
    * Does something cool 
    * @return 
    * Always returns 1 
    */ 
     public function bar() { 
     return 1; 
     } 
    } 

Doxygen не зарегистрирует функции-члена «бар»

Если я вынимаю на «общественность» ключевое слово , оно делает. Есть ли какие-то настройки, которые контролируют это? Я смотрел онлайн и ничего не видел об этом.

Answer 1

Поскольку это член класса, вам также нужно прокомментировать класс, чтобы doxygen знал, что нужно искать внутри класса для функций-членов. Сделайте что-нибудь подобное раньше класс Foo

/** 
* @class Foo 
* 
* The foo class is awesome 
*/ 

Вот код, я использую (именно твой плюс тот комментарий), который генерирует выходной сигнал на ссылку ниже.

<?php 

/** 
* @class Foo 
* 
* The foo class is awesome 
*/ 
class Foo{ 

    /** 
    * Does something cool 
    * @return 
    * Always returns 1 
    */ 
     public function bar() { 
     return 1; 
     } 
} 

?> 

http://raged.microsonic.org/test/html/classFoo.html

Надежда, что помогает, удачи!

На боковой ноте всегда рекомендуется (особенно для документации) перечислить ваши типы var в качестве предлагаемого плаката. Обычно я объявляю каждый @param и @return как некоторый тип переменной (так как я исхожу из фона C++), хотя это не совсем необходимо в PHP. В PHP вы, как правило, имеете много «смешанных» типов var, где это не могло случиться в C++. В любом случае удачи в вашем проекте!

Answer 2

Оказалось, что я использую неправильную версию doxygen. На моем пути уже был doxygen, и он указывал на 1.3x. Теперь все работает.