On 5/27/10 3:15 PM, Adam Richardson wrote:
On Thu, May 27, 2010 at 3:59 PM, Waynn Lue wrote:
I've seen @inheritDoc used in Java before, though I'm not sure about
the php support.
Waynn
You're absolutely right, Waynn,
Phpdocumentor has this, too:
http://manual.phpdoc.org/HTMLSmartyConvert
On Thu, May 27, 2010 at 3:59 PM, Waynn Lue wrote:
> I've seen @inheritDoc used in Java before, though I'm not sure about
> the php support.
>
> Waynn
>
> On 5/27/10, Adam Richardson wrote:
> >>
> >>
> >> > Larry,
> >> >
> >> > I've thought about this very issue before (java developers sometimes
I've seen @inheritDoc used in Java before, though I'm not sure about
the php support.
Waynn
On 5/27/10, Adam Richardson wrote:
>>
>>
>> > Larry,
>> >
>> > I've thought about this very issue before (java developers sometimes
>> lament
>> > this issue, too), and I error on the side of duplication
>
>
> > Larry,
> >
> > I've thought about this very issue before (java developers sometimes
> lament
> > this issue, too), and I error on the side of duplication if I'm using
> > inheritance.
> >
> > However, I'd say I rarely use inheritance for anything in my development,
> > and I'm much more lik
On Thu, May 27, 2010 at 1:14 PM, la...@garfieldtech.com <
la...@garfieldtech.com> wrote:
> On 5/27/10 12:10 PM, Adam Richardson wrote:
>
> Larry,
>>
>> I've thought about this very issue before (java developers sometimes
>> lament
>> this issue, too), and I error on the side of duplication if I'm
On 27 May 2010 18:10, Adam Richardson wrote:
> On Thu, May 27, 2010 at 12:44 PM, la...@garfieldtech.com <
> la...@garfieldtech.com> wrote:
>
>> On 5/27/10 11:30 AM, Peter Lind wrote:
>>
>> Sure, but @param, @access and possibly @return are but a part. I stand
> by my words: document the paren
On 5/27/10 12:10 PM, Adam Richardson wrote:
Larry,
I've thought about this very issue before (java developers sometimes lament
this issue, too), and I error on the side of duplication if I'm using
inheritance.
However, I'd say I rarely use inheritance for anything in my development,
and I'm mu
On Thu, May 27, 2010 at 12:44 PM, la...@garfieldtech.com <
la...@garfieldtech.com> wrote:
> On 5/27/10 11:30 AM, Peter Lind wrote:
>
> Sure, but @param, @access and possibly @return are but a part. I stand
by my words: document the parent as a stub and provide actual
documentation for t
On 27 May 2010 17:21, la...@garfieldtech.com wrote:
> On 5/27/10 11:13 AM, Peter Lind wrote:
>
>>> I'm overriding the method because I want to change the *implementation*.
>>> The *interface* of it, which is documented in the docblock, should not
>>> change and it's a bug (and possibly compile er
On 5/27/10 11:30 AM, Peter Lind wrote:
Sure, but @param, @access and possibly @return are but a part. I stand
by my words: document the parent as a stub and provide actual
documentation for the real implementations. Otherwise you're trying to
be *clever* and will see the age-old result: you'll e
On 27 May 2010 18:21, la...@garfieldtech.com wrote:
> On 5/27/10 11:13 AM, Peter Lind wrote:
>
>>> I'm overriding the method because I want to change the *implementation*.
>>> The *interface* of it, which is documented in the docblock, should not
>>> change and it's a bug (and possibly compile er
On 5/27/10 11:13 AM, Peter Lind wrote:
I'm overriding the method because I want to change the *implementation*.
The *interface* of it, which is documented in the docblock, should not
change and it's a bug (and possibly compile error) if it does change. You
cannot, for instance, change what par
On 27 May 2010 17:57, la...@garfieldtech.com wrote:
> On 5/27/10 10:43 AM, Peter Lind wrote:
>
>> You're overriding the function. IDEs should *not* show the parent
>> documentation, because the parent function does *not* get called. It
>> only gets called if you do a specific parent::hello($a, $b)
On 5/27/10 10:43 AM, Peter Lind wrote:
You're overriding the function. IDEs should *not* show the parent
documentation, because the parent function does *not* get called. It
only gets called if you do a specific parent::hello($a, $b);
*snip*
So it seems like no matter what I do, someone gets
On 27 May 2010 17:15, la...@garfieldtech.com wrote:
> Hi folks.
>
> OK, so here's the deal. I am trying to figure out the "right" way to
> document methods in OO code that includes method overriding in child
> classes. Simple, right? Unfortunately, it seems the tools out there are
> making this
Hi folks.
OK, so here's the deal. I am trying to figure out the "right" way to
document methods in OO code that includes method overriding in child
classes. Simple, right? Unfortunately, it seems the tools out there
are making this much more complicated than it should be. Example:
class
16 matches
Mail list logo