[Lazarus] Help on FCL?

[Mattias Gaertner]

On Sat, 21 Jan 2012 19:28:40 +0100 (CET)
Michael Van Canneyt <michael at freepascal.org> wrote:

> 
> 
> On Sat, 21 Jan 2012, Mattias Gaertner wrote:
> 
> > On Fri, 20 Jan 2012 15:28:33 +0100 (CET)
> > michael.vancanneyt at wisa.be wrote:
> >
> >>
> >>
> >> On Fri, 20 Jan 2012, Hans-Peter Diettrich wrote:
> >>
> >>>>
> >>>> Is this a limitation of the fpdoc chm writer?
> >>>
> >>> It's a limitation of fpdoc in general. It can generate documentation only for
> >>> single *packages* (--package=xyz). This does not matter much when building
> >>> HTML help, residing in a bunch of related HTML files, but it matters with
> >>> every linear (monolithic) document, be CHM, PDF etc.
> >>
> >> This is not a limitation; It is a feature: your documentation package name
> >> can be anything you want. If you equal "fpdoc package" to  "lazarus package",
> >> then this is a restriction that you personally enforce, not something that
> >> fpdoc enforces.
> >
> > What characters are valid for the fpdoc package name?
> 
> Any valid pascal identifier should do. 
> It definitely cannot contain . and #

What about spaces, <, >, ", ', &, -, +, /?

 
>[...]
> > I added an option to Lazarus packages/projects to define the fpdoc
> > package name. This is currently only used for newly created fpdoc files.
> > Eventually a renaming tool should be written.
> >
> 
> Well, you could make it default to the package/project name. 
> This way you don't need to do anything  ?

Of course it is the default. :)

 
> >> 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?
> 
> Filter.

Great!


Mattias