[fpc-pascal] Re: Where and how is the FPC documentation created?

[michael.vancanneyt at wisa.be]

On Thu, 1 Mar 2012, Reinier Olislagers wrote:

>>> When that didn't throw up errors and generated a valid ibconnection.chm,
>>> I didn't look for any further errors.
>>
>> It should have given you the same errors as I got. But it will produce a
>> chm file, simply with some parts missing.
>>
>> Originally, fpdoc would simply bomb out on the smallest mistake.
>>
>> I got plenty of complaints about that, so now, recoverable errors are just
>> displayed, but fpdoc will happily grind on and try and produce a file.
>
> I understand why you changed it, but didn't get any error messages
> either - just redownloaded the original patch upload to make sure:
>
> D:\Cop\t>c:\development\fpc\utils\fpdoc\fpdoc.exe --package=fcl
> --input=C:\Development\fpc\packages\fcl-db\src\sqldb\interbase\ibconnection.pp
> --format=chm --output=ibconnection.chm --content
> FPDoc - Free Pascal Documentation Tool
> Version 2.6.1 [2012/02/29]
> (c) 2000 - 2003 Areca Systems GmbH / Sebastian Guenther, sg at freepascal.org
>
> Writing 91 pages...
> HTML Files written. Collecting other files and compressing...this could
> take some time
> Finishing compressing...
> Done.

This is what I get:

[#fcl.IBConnection.TIBConnection] Invalid paragraph content
[#fcl.IBConnection.TIBConnection] Invalid paragraph content
[#fcl.IBConnection.TIBConnection.Dialect] Invalid description (illegal XML element: "#text")
[#fcl.IBConnection.TIBConnection.Params] Invalid description (illegal XML element: "var")
[#fcl.IBConnection.TIBConnection.Params] Invalid description (illegal XML element: "#text")
[#fcl.IBConnection.TIBConnection.Params] Invalid description (illegal XML element: "link")
[#fcl.IBConnection.TIBConnection.Params] Invalid description (illegal XML element: "#text")
Done.

But I don't use chm, but latex. I suppose the xml->html converter is more
forgiving about mistakes in your XML; maybe it takes some shortcuts. 
I would have to investigate.

It's something to note, in each case.

Michael.