Zitat von Michael Van Canneyt <[EMAIL PROTECTED]>:

>[...]
> > > The problem is that you may or may not have the definition (and
> > > corresponding page) in memory. If the parent def (and doc) is not
> > > in memory, you don't know whether a page is available or not.
> >
> > How do the links to the ancestor classes work?
>
> Through a complicated search mechanism :-)

Ok.


> > > > If yes, then it might be possible to traverse through all ancestors and
> > > find the
> > > > next existing short description, right?
> > >
> > > In theory, yes.
> >
> > :)
> >
> >
> > > Then you need to decide what to do:
> > > - Create a page for TChild.Property and simply refer to TParent.property
> > >   (a braindead solution imho)
> > > - do not generate a page but In the 'Property/methods/Class overview' of
> > > TChild,
> > >   refer to TParent.property whenever TChild.Property is not documented.
> > >
> > > In the latter case, pressing F1 on TChild.Property will refer to a
> > > non-existing page.
> >
> > The final presentation whether fpdoc creates a 'see also' link OR copies
> the
> > content OR refers directly is a second step. First fpdoc must gather some
> data:
> >
> > 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.

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?


Mattias

_______________________________________________
fpc-devel maillist  -  fpc-devel@lists.freepascal.org
http://lists.freepascal.org/mailman/listinfo/fpc-devel

Reply via email to