In the past days I've updated the LCL docs, in detail for Controls and ImgList. Please look for [...?] annotations, and fix what I couldn't determine myself. Patches can be sent to .

Some batch files for Windows users have been added, see StyleGuide.txt. Please copy mkhtml.bat to the proper location (docs\html\), and apply FileSearch.patch (Mantis #20137) before creating local HTML documentation.

Thanks to all documentation writers :-)

DoDi

Hans-Peter Diettrich wrote

In the past days I've updated the LCL docs,

Some weeks ago I hard but unsuccessful tried to compile the DocView files for the lcl documentation. Is this possible now ?

Thanks,
-Michael

Michael Schnell wrote

in the command line, but I don't see what the "/path/to/fpdoc" is supposed to be.

The full path to your 'fpdoc' executable that came with FPC.

This is warnings generated by 'build_lcl_docs', not 'fpdoc'.

eg:
$ ./build_lcl_docs --showcmd
Warning! No corresponding xml file for unit /Controls_lcl.pas Warning! No corresponding xml file for unit /paswstring.pas Warning! No corresponding xml file for unit forms/forms.pp fpdoc --content=lcl.xct --package=lcl --descr=../../xml/lcl/lcl.xml --format=html
--descr=../../xml/lcl//actnlist.xml
--descr=../../xml/lcl//alllclunits.xml
--descr=../../xml/lcl//arrow.xml
--descr=../../xml/lcl//asyncprocess.xml
--descr=../../xml/lcl//avglvltree.xml
--descr=../../xml/lcl//barchart.xml --descr=../../xml/lcl//butt ....snip...

Passing the --showcmd parameter, simply outputs how it will call fpdoc, but doesn't actually call it. Yet those "Warnings" are there.

For more information on what parameters 'build_lcl_docs' support, pass the --help parameter to it.

"build_lcl_docs" seemingly calls fpdoc and fpdoc is the program that crashes.

I think it might be due to the warnings generated by build_lcl_docs, but I might be wrong. I suggest you use the --showcmd parameter, and save the console output to a file. Then comment blocks of lines to narrow down what parameter / unit causes fpdoc to crash in your case.

Michael Schnell wrote

> This is warnings generated by 'build_lcl_docs', not 'fpdoc'. Obviously

It wasn't that obvious to me. :)

Sorry, no idea what you are meaning here. In what file(s) should I comment this out and how ? In fact I have no idea what file(s) build_lcl_docs reads and for what purpose.

Take that very long output you got from 'build_lcl_docs --showcmd ...' and save it to a file.

- Then make a copy of that file.
- then delete the first half of all the parameters send to fpdoc. (those --descr=..... parameters)
thus reducing what fpdoc will process.
- Run and see if it generates a lcl.ipf file.
- if it works, add a few more of those --descr= parameters back and run fpdoc again.
- keep going until you find out what unit causes fpdoc to crash.

....or....

Or try and run the whole lot from inside GDB, and maybe GDB can give you a backtrace locating the point of failure.

These warnings are crap, there doesn't exist a forms/forms.pp file. I supplied an according patch, changing 2 lines in build_lcl_docs fixes the file search. I wonder when this patch will be applied to trunk...

But why use build_lcl_docs, when scripts are supplied for Linux?

The "//" also is part of the buggy file search, fixed with my patch.

Passing the --showcmd parameter, simply outputs how it will call fpdoc, but doesn't actually call it. Yet those "Warnings" are there.

It should be noted that build_lcl_docs executes fpdoc within the html/lcl directory, therefore the many ../

build_lcl_docs saves the list of xml files in inputfile.txt, which must be updated to exclude suspect files.

I also supplied mkhtml.bat, to build the docs for only one LCL unit. It should not be complicated to adopt it to Linux.

DoDi

Michael Schnell wrote

> thus reducing what fpdoc will process. ??? How will fpdoc know about my edited file ???

Because your edited file is a script (*.sh) or batch (*.bat) file. You run your edited file.