Documentation fixes

[Patrik Stridvall]

> Patrik Stridvall <ps at leissner.se> writes:
> 
> > Documentation fixes.
> 
> A number of these are not correct so I have not applied them. For
> instance you have added documentation for stub entry points (like in
> controls/menu.c) 

Yes, that is a minor easily fixable bug. Fixed.

> or for functions implemented in another dll. The
> problem is most likely that you are only matching on the function
> name, but it happens that entry point names are duplicated (like the
> 16-bit registry functions between kernel and shell).
> 
> Maybe you could add a check for that?  Basically you should never have
> a comment that mentions a dll from another directory, like a
> KERNEL32.@ in a file in dlls/shell32. Of course the directory
> structure is not 100% clean yet so this is not entirely trivial.

As you said, it is not entirely trivial to do.
Fortunately I have a list in tools/winapi_check/modules.dat
that specificies which directory each spec files has its
implemntations in. The information was not 100% used
though, since I thought it was non trivial do it properly.

However, now I have finally done it, eventhough it took some time.
The winapi_{check,fixup} change will be submitted separately
with the ordinary winapi update.

Anyway here is the result of running the new version
of winapi_fixup. As you can see some Win16 stubs was
added eariler by mistake as well as some cross
directory comments.

PS. And yes, the added lstrcmpi (USER.471) in memory/string.c
should really be there. Both KERNEL and USER uses the memory
directory. Of course USER should probably not use the memory
directory at all, but that is not winapi_{check,fixup}'s
problem AFAICS.

---8<---

*** documentation

* dlls/kernel/thunk.c,
  dlls/ole32/storage32.c,
  dlls/rasapi32/rasapi.c,
  dlls/shell32/shellole.c,
  dlls/winsock/socket.c,
  files/dos_fs.c,
  graphics/fontengine.c,
  memory/heap.c,
  memory/string.c,
  objects/dc.c,
  objects/gdiobj.c,
  objects/pen.c,
  objects/region.c,
  windows/input.c,
  windows/mdi.c,
  windows/message.c,
  windows/syscolor.c,
  windows/winpos.c:
Documentation fixes.

-------------- next part --------------
A non-text attachment was scrubbed...
Name: documentation.diff
Type: application/octet-stream
Size: 17015 bytes
Desc: not available
Url : http://www.winehq.org/pipermail/wine-patches/attachments/20010712/8ca76888/documentation.obj