Sign in Join

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

Mailing lists / fpc-devel / 2011-12

Bad links in RTL docs

4 messages · 3 people ·

Reply by email Subscribe to this list Your subscription

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

Hans-Peter Diettrich

FPDoc doesn't find targets for these links:

math.TRoundToRange - range types never become part of the documentation!

   type TRoundToRange = -37..37;

I suspect that fpdoc wants an type name after the "=", which here doesn't exist. Applies to all range types, not only this one.

system.Power - most system units seem not to export the power() emulation, so that the links better go to math.power()?

system.IsVariantManagerSet - seems not to exist any more?

system.VarDispProc?

system.TSystemTime?

sysutils.OnBeep?
Neither OnBeep nor TBeepHandler seem to find their way into the (HTML) docs?

sockets.Socket, SocketPair, Send, Recv, Listen?

I've tried to fix the obvious errors, and will create an patch. Some missing links result from typos, others from missing qualifiers. It looks like <link ID=... is not recognized, should read <link id=...

DoDi

Marco van de Voort
to Hans-Peter Diettrich

In our previous episode, Hans-Peter Diettrich said:

Show quoted text 6 lines
FPDoc doesn't find targets for these links: math.TRoundToRange - range types never become part of the documentation! type TRoundToRange = -37..37; I suspect that fpdoc wants an type name after the "=", which here doesn't exist. Applies to all range types, not only this one.

See also
http://bugs.freepascal.org/view.php?id=17352

sysutils.OnBeep? Neither OnBeep nor TBeepHandler seem to find their way into the (HTML) docs?

IIRC related to a rev that was never merged to 2.4.x. Do you use 2.6.x as basis?

sockets.Socket, SocketPair, Send, Recv, Listen?

Deprecated already in 2.4.x. However some variants that used the text record versions still exist. A decision what to do with them was never taken.

Michael Van Canneyt
to Hans-Peter Diettrich: FPDoc doesn't find targets for these links: math.TRoundToRange - range types never become…
Hans-Peter Diettrich wrote 6 lines
FPDoc doesn't find targets for these links: math.TRoundToRange - range types never become part of the documentation! type TRoundToRange = -37..37; I suspect that fpdoc wants an type name after the "=", which here doesn't exist. Applies to all range types, not only this one.

Please create a bug report.

system.Power - most system units seem not to export the power() emulation, so that the links better go to math.power()?

No, this should go in the fpdoc dummies.

Show quoted text 9 lines
system.IsVariantManagerSet - seems not to exist any more? system.VarDispProc? system.TSystemTime? sysutils.OnBeep? Neither OnBeep nor TBeepHandler seem to find their way into the (HTML) docs?

That must be checked.

sockets.Socket, SocketPair, Send, Recv, Listen?

Same here.

I've tried to fix the obvious errors, and will create an patch. Some missing links result from typos, others from missing qualifiers. It looks like <link ID=... is not recognized, should read <link id=...

That is correct. XML is case sensitive.

Michael.

Hans-Peter Diettrich
to Marco van de Voort: In our previous episode, Hans-Peter Diettrich said: See also…
Show quoted text 10 lines
In our previous episode, Hans-Peter Diettrich said: > FPDoc doesn't find targets for these links: > > math.TRoundToRange - range types never become part of the documentation! > type TRoundToRange = -37..37; > I suspect that fpdoc wants an type name after the "=", which here > doesn't exist. Applies to all range types, not only this one. See also http://bugs.freepascal.org/view.php?id=17352

Seems to address the same issue.

Show quoted text 5 lines
> sysutils.OnBeep? > Neither OnBeep nor TBeepHandler seem to find their way into the (HTML) docs? IIRC related to a rev that was never merged to 2.4.x. Do you use 2.6.x as basis?

I use 2.4.2 to build the docs, and check with the trunk version for significant differences. Didn't use 2.6 so far, waiting for Lazarus supporting it.

Thanks to Michael for the quick application of my patch :-)

DoDi