doxygen-develop

RE: [Doxygen-develop] RE: PHP and aggregated Objects

[<rue...@to...>]

Hi Jens,

Jens Miltner <mailto:ju...@ma...> wrote on Monday, September 26, 2005 11:53
AM:

> Hmmh, never tried with any php sources. However, I found that I have
> to move the description of the member variable into a separate line
> in order to get it into the documentation:
> 
> class Test
> {
> public:
>      /*!
>       * @var const foo* bar
>       * \brief a member variable
>       */
>      int    bar;
> };
> 
> (Note that the type difference between the actual declaration
> and the
> documentation is deliberately in this case, because I wanted
> to check
> that the documented type is actually used).
> Maybe using a similar approach may work with php sources?
> 
> HTH,
> </jum>

Thx for your answer. I tried several methods inspired from your example, but
doxygen ignores everything except writing the type between visibilty and the
variable name. And that's no valid PHP syntax :-/

Best regrards.

Re: [Doxygen-develop] RE: PHP and aggregated Objects

[Marek L. <ma...@le...>]

Sönke Ruempler napisał(a):
> Hi Jens,
> 
> 
> Thx for your answer. I tried several methods inspired from your example, but
> doxygen ignores everything except writing the type between visibilty and the
> variable name. And that's no valid PHP syntax :-/

Try this:

class TestClass {
	
	/**
	 * Brief description.
	 *
	 * Detailed description.
	 */
	public $someVar;
	
	/**
	 * Some method.
	 */
	public static function f2 () {
	}
}


As you see Doxygen will generate documentation for $someVar, however you 
cannot put "@var" tag. It seems like a bug, because when you put "@var 
$someVar" doxygen looks for TestClass::someVar member.

ML

 

RE: [Doxygen-develop] RE: PHP and aggregated Objects

[<rue...@to...>]

Hi,

Marek Lewczuk <mailto:ma...@le...> wrote on Monday, September 26, =
2005 1:51 PM:

> As you see Doxygen will generate documentation for $someVar, however
> you cannot put "@var" tag. It seems like a bug, because when you put
> "@var $someVar" doxygen looks for TestClass::someVar member.
>=20
> ML

Yes, that's my experiences, too. May any developer please check this?

Best Regards.

Re: [Doxygen-develop] RE: PHP and aggregated Objects

[Dimitri v. H. <di...@st...>]

On Tue, Sep 27, 2005 at 08:17:50AM +0200, S??nke Ruempler wrote:
> Hi,
> 
> Marek Lewczuk <mailto:ma...@le...> wrote on Monday, September 26, 2005 1:51 PM:
> 
> > As you see Doxygen will generate documentation for $someVar, however
> > you cannot put "@var" tag. It seems like a bug, because when you put
> > "@var $someVar" doxygen looks for TestClass::someVar member.
> > 
> > ML
> 
> Yes, that's my experiences, too. May any developer please check this?

You typically should not use @var to try to fool doxygen. In fact you should
not use it at all if the comment block is in front of the variable definition.

If you still think there is a bug (which is certainly possible for PHP) then
please report it using the bug tracker. First describe the bug and then
attach a self-contained example so I can reproduce the problem.

Regards,
  Dimitri