Sign in Join

Live chat for Free Pascal, Lazarus, Delphi and every Pascal programmer.

Mailing lists / lazarus / 2011-09

Bugs in LCL documentation

2 messages · 2 people · –

Reply by email Subscribe to this list Your subscription

Read-only archive. Use j and k to move between messages.

Hans-Peter Diettrich

I've just found and fixed an bug in the file search of build_lcl_docs, which prevented proper search of subdirectories. This made e.g. the wrong error message about forms\forms.pp disappear, now instead new problems with missing files are reported, mostly addressing the interfaces\ (widgetsets) directories.

Now we can start to fix the hints and errors, reported by fpdocs (until it crashes with an AV). A couple of entries read like

Warning: Target ID of <link> is unknown:
"#LCL.StdCtrls.TCustomButton.Destroy"

where the links often lead to inexistent or protected class members, for which no documentation is created (by default). Should we simply ignore such hints, or should the links go to the public properties instead of their protected getters/setters?

DoDi

Reply by email

Marco van de Voort
to Hans-Peter Diettrich
Hans-Peter Diettrich wrote 16 lines
I've just found and fixed an bug in the file search of build_lcl_docs, which prevented proper search of subdirectories. This made e.g. the wrong error message about forms\forms.pp disappear, now instead new problems with missing files are reported, mostly addressing the interfaces\ (widgetsets) directories. Now we can start to fix the hints and errors, reported by fpdocs (until it crashes with an AV). A couple of entries read like Warning: Target ID of <link> is unknown: "#LCL.StdCtrls.TCustomButton.Destroy" where the links often lead to inexistent or protected class members, for which no documentation is created (by default). Should we simply ignore such hints, or should the links go to the public properties instead of their protected getters/setters?

Maybe protected functions should only be hidden if their nodes are empty.

Reply by email