[fpc-devel] fpdoc inherited entries
Michael Van Canneyt
michael at freepascal.org
Mon Feb 18 16:17:52 CET 2008
On Mon, 18 Feb 2008, Mattias Gärtner wrote:
> > > It should only refer, iff the TChild.Property is not documented (= has no
> > short
> > > description) and iff there is a documented TParent.Property, where TParent
> > does
> > > not need to be the direct ancestor. For example TButton.Caption should not
> > refer
> > > to TCustomButton.Caption nor TWinControl.Caption, but to TControl.Caption.
> > I am more in favour of adding a new attribute to allow more control by the
> > documentor:
> > <element name="TButton.Caption" link="TControl.Caption"/>
> > It has the advantage of being faster as well: the documenting process can
> > use some speedup, it gets slower by the day. The disadvantage is that you
> > must fill it in manually - although a simple button in the editor can take
> > care of that:
> > - fill this property for the current element,
> > or
> > - for all elements with <fill your favorite recipe here> fill the closest
> > ancestor.
> Ey, I thought I do the proposal and you do the implementation!?
> Now it seems I have to implement this 'for all elements' function in the editor.
Clever twist of me, eh ? ;-)
> Will you implement the fpdoc part, that means the 'link' attribute, so that
> fpdoc does not create the TChild.Property pages and instead directly links to
> the linked page and update the fpdoc docs?
It means a lot of checking, though, because all <link id=""> references to
TChild.Property must also be changed. If speed is affected, maybe I'll have
to do some tricks in the search mechanism as well :(
More information about the fpc-devel