[fpc-devel] [Fwd: Re: [Lazarusdev] FPDoc links to RTL, FCL]

[Chris Kirkpatrick]

At the suggestion of Mattias, I am also sending this to fpc-devel. I 
don't think it's a bug; the entries are all documented in the RTL .xml 
files, but when the docs are built for the sourceforge HTML files the 
RTL files are obviously built with the --hide-protected option.

Links in entries of the LCL that refer to RTL protected properties are 
not recognised.

I believe the solution is to remove the --hide-protected option from the 
script that generates the documentation files.

Regards - Chris

-------- Original Message --------
Subject: 	Re: [Lazarusdev] FPDoc links to RTL, FCL
Date: 	Wed, 27 Aug 2008 12:11:24 +0200
From: 	Mattias Gärtner <nc-gaertnma at netcologne.de>
Reply-To: 	Lazarus Developers List <lazarusdev at lazarus.freepascal.org>
To: 	Lazarus Developers List <lazarusdev at lazarus.freepascal.org>
References: 	<48B51A84.3070100 at doctors.org.uk>



Zitat von Chris Kirkpatrick <chris.kirkpatrick at doctors.org.uk>:

> I have been documenting help files with links to inherited properties
> and methods; these now work pretty well, but if I include a link to a
> description of a protected property/method in the RTL or FCL it is not
> recognised (even though the property is described in the sources).
>
> Examples: links to TComponent.Loaded and TPersistent.AssignTo
>
> I believe that this is because the HTML documents for RTL/FCL are
> created using the hide-protected option, while the LCL documents do not
> use this option.
>
> Is there any way the protected properties could be revealed in the
> RTL/FCL docs? Or would they become too huge and cumbersome? Otherwise we
> simply have to accept that some links won't be recognised.

IMO protected members must be documented too. Ask on the fpc list or create a
bug report.

Mattias

_______________________________________________
Lazarusdev mailing list
Lazarusdev at lazarus.freepascal.org
http://www.lazarus.freepascal.org/mailman/listinfo/lazarusdev