Sign in Join

Live chat for Free Pascal, Lazarus, Delphi and every Pascal programmer.

Mailing lists / fpc-pascal / 2012-01

fpdoc links and short description

4 messages · 2 people ·

Reply by email Subscribe to this list Your subscription

Read-only archive. Use j and k to move between messages.

Felipe Monteiro de Carvalho

Hello,

I havent seen an answer for this in the other thread and it is getting too big. So, in fpdoc if we make a link like this:

<element name="TShellTreeView.OnMouseDown"
link="#LCL.Controls.TControl.OnMouseDown"/>

It does not properly link the short description when listing elements of a class, for example.

Is this a bug or should it work like this?

Is it possible to link the short description too? How?

thanks,

Felipe Monteiro de Carvalho
Unknown author
to Felipe Monteiro de Carvalho: I havent seen an answer for this in the other thread and it is getting too big. So, in…
Felipe Monteiro de Carvalho wrote 12 lines
Hello, I havent seen an answer for this in the other thread and it is getting too big. So, in fpdoc if we make a link like this: <element name="TShellTreeView.OnMouseDown" link="#LCL.Controls.TControl.OnMouseDown"/> It does not properly link the short description when listing elements of a class, for example. Is this a bug or should it work like this?

Most likely a bug, please report it.

Michael.

Felipe Monteiro de Carvalho
to Felipe Monteiro de Carvalho: umm, now I have rebuilt the docs and it obtained the short description in the top-level…

Aha! I found the gotcha!

If I write the link like this:

<element name="TRadioGroup.OnSelectionChanged"
link="TCustomRadioGroup.OnSelectionChanged">
<short/>
<descr/>
<seealso/>
</element>

Then it links properly (clicking makes it go to
TCustomRadioGroup.OnSelectionChanged) but it will not copy the short description to the class overview. But it does that if I link like this:

<element name="TRadioGroup.OnSelectionChanged"
link="#lcl.ExtCtrls.TCustomRadioGroup.OnSelectionChanged"> <short/>
<descr/>
<seealso/>
</element>

Felipe Monteiro de Carvalho