[Lazarus] Help on FCL?

[Hans-Peter Diettrich]

Mattias Gaertner schrieb:

> The package name in the fpcdocs xml files is lower case "fcl".
> Is the name case insensitive?

AFAIR not, the LCL docs use both "LCL" and "lcl".


> I added an option to Lazarus packages/projects to define the fpdoc
> package name. This is currently only used for newly created fpdoc files.

Great :-)

> Eventually a renaming tool should be written.

Such an option could be added to the FPDocManager. But I see no need so 
far, the LCLBase docs already (still!) refer to package lcl, and no docs 
exist yet for LazUtils.


>> This is still only 1-on-N, but that's still better than the 1-on-1 if you equal 
>> "fpdoc package" to "lazarus package".
> 
> The package name can be used in links (e.g. link
> id="#fcl.zstream.Tgzfilestream"). Is this the package name in the xml file or the option passed to fpdoc?
> Or in other words: What is the --package option? filter or rename?

It's a filter, with no special advantage, but prohibiting e.g. RTL, FCL 
and LCL documentation merged into an single CHM file. Only matching 
<package name=xyz> sections are added from the xml files. The fpdoc 
inventors assumed that a single xml file could span multiple packages, 
what IMO is not very realistic. In addition only those descriptions 
become part of the output, which have corresponding input (source 
module) files. Lazarus help and FPDoc Editor already assume that the 
source and description files have the same (unit) name, but this is not 
a requirement.

DoDi