@property seems to be ignored

38 views
Skip to first unread message

christi...@antevorte.org

unread,
Jul 17, 2013, 9:18:16 AM7/17/13
to api...@googlegroups.com, christi...@gmail.com
Hello,

i just installed apigen and tried it out with a bunch of PHP files. It's nearly working like expected but it seems, @property tags are ignored.


So lets say I have a PHP class like this:

<?php
/**
* FooBar
* @property integer $number the number of the thing
*/
class FooBar 
{
protected $number = 0; 
}

If I create the HTML documentation with apigen now the class attribute appears but without any description.
I expect "the number of the thing" is used.

What am I doing wrong?

Greets,
Chris

Tristan Lins

unread,
Jul 18, 2013, 4:27:26 AM7/18/13
to api...@googlegroups.com
Hi,

phpdoc.org says that @property is for magic properties only:
http://www.phpdoc.org/docs/latest/for-users/phpdoc/tags/property.html

You should document your non-magic properties this way:

<?php
/**
* FooBar
*/
class FooBar
{
/**
* @var integer the number of the thing
*/
protected $number = 0;
}

But you may right, that @property is not yet supported by apigen.

Best regards
Tristan
--
Tristan Lins - Inhaber, Softwareentwickler
bit3 UG (haftungsbeschr�nkt)
Im Coenen Palais � Hofstr. 272 � 56077 Koblenz
in...@bit3.dehttp://bit3.de � 0261-45093253
Amtsgericht Koblenz, HRB 23386

gabrielol...@gmail.com

unread,
Sep 3, 2013, 9:24:54 AM9/3/13
to api...@googlegroups.com
Hello!

Do you guys intend to implement the tags property and method in future releases of ApiGen?

Best regards.
bit3 UG (haftungsbeschr�nkt)
Im Coenen Palais � Hofstr. 272 � 56077 Koblenz
in...@bit3.de � http://bit3.de � 0261-45093253
Amtsgericht Koblenz, HRB 23386
Reply all
Reply to author
Forward
0 new messages