[fpc-devel] Makeskel errors on Windows

[Michael Van Canneyt]

On Fri, 9 Dec 2011, Hans-Peter Diettrich wrote:

> Michael Van Canneyt schrieb:
>
>> And as long as it is not 100% documented, it will not be added.
>> In other words, the windows unit will probably never make it in the 
>> official docs.
>
> At least TSystemTime is declared there, used in GetLocalTime (Win32 
> platform). Dunno about other types or constants, used in other Win32 RTL and 
> FCL units (winsocks...).

If you'd check carefully TSystemTime is declared and documented in sysutils.

If you build for Win32, then it's not documented, because on windows, the windows 
unit definition is used. It's one of the reasons why I explicitly build for Linux:
the RTL contains many structures that have their roots in the win32 API.
On other platforms, these structures are defined explicitly outside the 
windows unit, and hence, documented.

So it seems to me you created an artificial problem.

>
>> I do not think it makes any sense to do so anyway. The windows API is best 
>> documented on MSDN; You'd be far better off finding a system that links to 
>> MSDN as soon as F1 is pressed on a windows unit identifier. Empty 
>> documentation is of no use to anyone.
>
> Type declarations and constants are useful even without detailed 
> documentation.

Nonsense. 
ctrl-click in the IDE will get you more info by actually jumping to the declaration.

> When I started to document the LCL, I found many (Delphi) 
> functions based on the WinAPI, so that some documentation is required anyhow.

Once more, I think you should let the WinAPI be documented by MSDN.
No need to drag in things that are better documented somewhere else.
But if you want to spend your time on it, who am I to stop you ?

If you finish documenting actual FPC/Lazarus code, then I think 
your mission will have succeeded.

Michael.