Re: New file for CVS checkin please
| From: | Hannes Magnusson | Date: | Thu, 23 Oct 2008 10:21:18 +0000 |
| Subject: | Re: New file for CVS checkin please | ||
| References: | 1 2 3 4 5 | Groups: | php.doc |
| Request: | Send a blank email to phpdoc+get-969379538@lists.php.net to get a copy of this message | ||
On Thu, Oct 23, 2008 at 11:29, Anthony Bedford <Tony.Bedford@sun.com> wrote:
> Hannes Magnusson wrote:
>
>> If you believe <property> would be the appropriate markup for it then
>> we can implement it in PhD without ASAP.
>> How do you want it to work?
>> To link to class variables:
>> <property>classname->variablename</property> to reference class
>> variable and <property>classname::variablename</property> to reference
>> static variable (::$varname and ::varname would both generate <a
>> href="...">classname::$varname</a> markup)?
>
> That sounds about right.
>
> In the markup I'd write:
>
> <property>mysqli->affected_rows</property>
The problem here, which I didn't realize immediately, is that would
have to be <property>mysql->varname</property>...
> So that's basically the same as what you said (with the small addition of
> the auto-generated '$' in the output of the first case).
>
> Does that look OK?
Sounds good. I will bet there will creep in classname->foobar errors
(unescaped >) from time to time..
How would the actual documentation of the variable look like?
If we use the current
<classsynopsis>
<ooclass><classname>classname></classname></ooclass>
<fieldsynopsis>
<modifier>static</modifier><modifier>public</modifier>
<type>string</type><varname>foobar</varname>
</fieldsynopsis>
</classsynopsis>
markup, we could have <property>clssname::property</property>
automatically figure out if its a static variable or not, therefore
avoiding the problem of escaping > for normal props..
-Hannes