[fpc-devel] fpc docs have hidden documentation

Graeme Geldenhuys graemeg.lists at gmail.com
Fri Aug 27 12:13:49 CEST 2010


In the case of Classes unit documentation - more specifically the TThread
documentation. The default behaviour when making RTL documentation, is for
it to hide/exclude the "protected" section from the docs.

This includes the TThread.Execute and TThread.Synchronize methods, which
actually has documentation elements in the classes.xml file.

Now the problem is, some other areas of TThread docs reference the
documentation of TThread.Execute and TThread.Synchronize. Because they are
protected, they are excluded from the docs - causing unresolved links.

Should we just ignore this problem?

All documentation output formats are affected. Take a look at this URL, and
the link right at the bottom of the page. TThread.Execute points to nothing
specific, but TThread itself.


That's one example, there are about 6 or so of them.

  - Graeme -

fpGUI Toolkit - a cross-platform GUI toolkit using Free Pascal

More information about the fpc-devel mailing list