kernel: improve c2man documentation
Markus Amsler
markus.amsler at oribi.org
Tue Nov 8 00:04:38 CST 2005
This patch improves the c2man Documented-Total count of kernel32 from
258(28%) to 304(33%) and of krnl386 from 33(9%) to 43(12%).
Changelog:
Markus Amsler <markus.amsler at oribi.org>
Improve c2man Documented-Total count. Changes:
- add missing description
- add missing returns section
- complete missing A/W pairs
- reformate comments, to match c2man requirements
-------------- next part --------------
Index: dlls/kernel/comm.c
===================================================================
RCS file: /home/wine/wine/dlls/kernel/comm.c,v
retrieving revision 1.98
diff -u -r1.98 comm.c
--- dlls/kernel/comm.c 3 Nov 2005 11:38:48 -0000 1.98
+++ dlls/kernel/comm.c 8 Nov 2005 05:57:23 -0000
@@ -2122,7 +2122,7 @@
* Interesting things (events) are set by calling SetCommMask before
* this function is called.
*
- * RETURNS:
+ * RETURNS
* TRUE if successful
* FALSE if failure
*
@@ -2286,7 +2286,7 @@
/***********************************************************************
* CommConfigDialogW (KERNEL32.@)
*
- * see CommConfigDialogA for more info
+ * See CommConfigDialogA.
*/
BOOL WINAPI CommConfigDialogW(
LPCWSTR lpszDevice, /* [in] name of communications device */
Index: dlls/kernel/computername.c
===================================================================
RCS file: /home/wine/wine/dlls/kernel/computername.c,v
retrieving revision 1.17
diff -u -r1.17 computername.c
--- dlls/kernel/computername.c 20 Jun 2005 10:40:37 -0000 1.17
+++ dlls/kernel/computername.c 8 Nov 2005 05:57:24 -0000
@@ -564,10 +564,14 @@
/******************************************************************************
* SetComputerNameW [KERNEL32.@]
*
+ * Set a new NetBIOS name for the local computer.
+ *
* PARAMS
* lpComputerName [I] Address of new computer name
*
- * RETURNS STD
+ * RETURNS
+ * Success: TRUE
+ * Failure: FALSE
*/
BOOL WINAPI SetComputerNameW( LPCWSTR lpComputerName )
{
@@ -634,6 +638,8 @@
/******************************************************************************
* SetComputerNameA [KERNEL32.@]
+ *
+ * See SetComputerNameW.
*/
BOOL WINAPI SetComputerNameA( LPCSTR lpComputerName )
{
Index: dlls/kernel/console.c
===================================================================
RCS file: /home/wine/wine/dlls/kernel/console.c,v
retrieving revision 1.44
diff -u -r1.44 console.c
--- dlls/kernel/console.c 9 Sep 2005 10:19:45 -0000 1.44
+++ dlls/kernel/console.c 8 Nov 2005 05:57:24 -0000
@@ -456,15 +456,9 @@
/******************************************************************************
- * WriteConsoleOutputCharacterA [KERNEL32.@] Copies character to consecutive
- * cells in the console screen buffer
+ * WriteConsoleOutputCharacterA [KERNEL32.@]
*
- * PARAMS
- * hConsoleOutput [I] Handle to screen buffer
- * str [I] Pointer to buffer with chars to write
- * length [I] Number of cells to write to
- * coord [I] Coords of first cell
- * lpNumCharsWritten [O] Pointer to number of cells written
+ * See WriteConsoleOutputCharacterW.
*/
BOOL WINAPI WriteConsoleOutputCharacterA( HANDLE hConsoleOutput, LPCSTR str, DWORD length,
COORD coord, LPDWORD lpNumCharsWritten )
@@ -533,16 +527,7 @@
/******************************************************************************
* FillConsoleOutputCharacterA [KERNEL32.@]
*
- * PARAMS
- * hConsoleOutput [I] Handle to screen buffer
- * ch [I] Character to write
- * length [I] Number of cells to write to
- * coord [I] Coords of first cell
- * lpNumCharsWritten [O] Pointer to number of cells written
- *
- * RETURNS
- * Success: TRUE
- * Failure: FALSE
+ * See FillConsoleOutputCharacterW.
*/
BOOL WINAPI FillConsoleOutputCharacterA( HANDLE hConsoleOutput, CHAR ch, DWORD length,
COORD coord, LPDWORD lpNumCharsWritten )
@@ -928,6 +913,8 @@
/***********************************************************************
* GetConsoleTitleA (KERNEL32.@)
+ *
+ * See GetConsoleTitleW.
*/
DWORD WINAPI GetConsoleTitleA(LPSTR title, DWORD size)
{
@@ -1308,8 +1295,9 @@
/******************************************************************************
- * WriteConsoleOutputCharacterW [KERNEL32.@] Copies character to consecutive
- * cells in the console screen buffer
+ * WriteConsoleOutputCharacterW [KERNEL32.@]
+ *
+ * Copy character to consecutive cells in the console screen buffer.
*
* PARAMS
* hConsoleOutput [I] Handle to screen buffer
@@ -2040,7 +2028,9 @@
* hConsoleOutput [I] Handle of console screen buffer
* dwCursorPosition [I] New cursor position coordinates
*
- * RETURNS STD
+ * RETURNS
+ * Success: TRUE
+ * Failure: FALSE
*/
BOOL WINAPI SetConsoleCursorPosition(HANDLE hcon, COORD pos)
{
Index: dlls/kernel/environ.c
===================================================================
RCS file: /home/wine/wine/dlls/kernel/environ.c,v
retrieving revision 1.6
diff -u -r1.6 environ.c
--- dlls/kernel/environ.c 14 Jun 2005 11:42:34 -0000 1.6
+++ dlls/kernel/environ.c 8 Nov 2005 05:57:24 -0000
@@ -94,8 +94,8 @@
/***********************************************************************
- * GetEnvironmentStrings (KERNEL32.@)
* GetEnvironmentStringsA (KERNEL32.@)
+ * GetEnvironmentStrings (KERNEL32.@)
*/
LPSTR WINAPI GetEnvironmentStringsA(void)
{
Index: dlls/kernel/file.c
===================================================================
RCS file: /home/wine/wine/dlls/kernel/file.c,v
retrieving revision 1.44
diff -u -r1.44 file.c
--- dlls/kernel/file.c 1 Nov 2005 21:37:05 -0000 1.44
+++ dlls/kernel/file.c 8 Nov 2005 05:57:25 -0000
@@ -1397,6 +1397,8 @@
/*************************************************************************
* CreateFileA (KERNEL32.@)
+ *
+ * See CreateFileW.
*/
HANDLE WINAPI CreateFileA( LPCSTR filename, DWORD access, DWORD sharing,
LPSECURITY_ATTRIBUTES sa, DWORD creation,
@@ -1976,6 +1978,8 @@
/******************************************************************************
* GetCompressedFileSizeW (KERNEL32.@)
*
+ * Get the actual number of bytes used on disk.
+ *
* RETURNS
* Success: Low-order doubleword of number of bytes
* Failure: INVALID_FILE_SIZE
@@ -2023,6 +2027,8 @@
/******************************************************************************
* GetCompressedFileSizeA (KERNEL32.@)
+ *
+ * See GetCompressedFileSizeW.
*/
DWORD WINAPI GetCompressedFileSizeA( LPCSTR name, LPDWORD size_high )
{
Index: dlls/kernel/file16.c
===================================================================
RCS file: /home/wine/wine/dlls/kernel/file16.c,v
retrieving revision 1.14
diff -u -r1.14 file16.c
--- dlls/kernel/file16.c 20 Jun 2005 10:40:37 -0000 1.14
+++ dlls/kernel/file16.c 8 Nov 2005 05:57:25 -0000
@@ -449,11 +449,16 @@
/***********************************************************************
* GetDriveType (KERNEL.136)
- * This function returns the type of a drive in Win16.
- * Note that it returns DRIVE_REMOTE for CD-ROMs, since MSCDEX uses the
- * remote drive API. The return value DRIVE_REMOTE for CD-ROMs has been
- * verified on Win 3.11 and Windows 95. Some programs rely on it, so don't
- * do any pseudo-clever changes.
+ * Get the type of a drive in Win16.
+ *
+ * RETURNS
+ * The type of the Drive. For a list see GetDriveTypeW from kernel32.
+ *
+ * NOTES
+ * Note that it returns DRIVE_REMOTE for CD-ROMs, since MSCDEX uses the
+ * remote drive API. The return value DRIVE_REMOTE for CD-ROMs has been
+ * verified on Win 3.11 and Windows 95. Some programs rely on it, so don't
+ * do any pseudo-clever changes.
*/
UINT16 WINAPI GetDriveType16( UINT16 drive ) /* [in] number (NOT letter) of drive */
{
Index: dlls/kernel/global16.c
===================================================================
RCS file: /home/wine/wine/dlls/kernel/global16.c,v
retrieving revision 1.14
diff -u -r1.14 global16.c
--- dlls/kernel/global16.c 29 Aug 2005 12:26:19 -0000 1.14
+++ dlls/kernel/global16.c 8 Nov 2005 05:57:25 -0000
@@ -257,6 +257,9 @@
/***********************************************************************
* GlobalAlloc (KERNEL.15)
* GlobalAlloc16 (KERNEL32.24)
+ *
+ * Allocate a global memory object.
+ *
* RETURNS
* Handle: Success
* NULL: Failure
@@ -275,6 +278,9 @@
/***********************************************************************
* GlobalReAlloc (KERNEL.16)
+ *
+ * Change the size or attributes of a global memory object.
+ *
* RETURNS
* Handle: Success
* NULL: Failure
@@ -568,6 +574,9 @@
/***********************************************************************
* GlobalSize (KERNEL.20)
* GlobalSize16 (KERNEL32.32)
+ *
+ * Get the current size of a global memory object.
+ *
* RETURNS
* Size in bytes of object
* 0: Failure
@@ -585,6 +594,9 @@
/***********************************************************************
* GlobalHandle (KERNEL.21)
+ *
+ * Get the handle associated with a pointer to the global memory block.
+ *
* NOTES
* Why is GlobalHandleToSel used here with the sel as input?
*
@@ -620,6 +632,8 @@
/***********************************************************************
* GlobalFlags (KERNEL.22)
*
+ * Get information about a global memory object.
+ *
* NOTES
* Should this return GMEM_INVALID_HANDLE instead of 0 on invalid
* handle?
@@ -767,6 +781,9 @@
/***********************************************************************
* GlobalDOSAlloc (KERNEL.184)
+ *
+ * Allocate memory in the first MB.
+ *
* RETURNS
* Address (HW=Paragraph segment; LW=Selector)
*/
@@ -793,6 +810,9 @@
/***********************************************************************
* GlobalDOSFree (KERNEL.185)
+ *
+ * Free memory allocated with GlobalDOSAlloc
+ *
* RETURNS
* NULL: Success
* sel: Failure
Index: dlls/kernel/heap.c
===================================================================
RCS file: /home/wine/wine/dlls/kernel/heap.c,v
retrieving revision 1.19
diff -u -r1.19 heap.c
--- dlls/kernel/heap.c 16 Aug 2005 16:00:36 -0000 1.19
+++ dlls/kernel/heap.c 8 Nov 2005 05:57:25 -0000
@@ -117,6 +117,9 @@
/***********************************************************************
* HeapCreate (KERNEL32.@)
+ *
+ * Create a heap object.
+ *
* RETURNS
* Handle of heap: Success
* NULL: Failure
@@ -145,6 +148,9 @@
/***********************************************************************
* HeapDestroy (KERNEL32.@)
+ *
+ * Destroy a heap object.
+ *
* RETURNS
* TRUE: Success
* FALSE: Failure
@@ -323,6 +329,9 @@
/***********************************************************************
* GlobalAlloc (KERNEL32.@)
+ *
+ * Allocate a global memory object.
+ *
* RETURNS
* Handle: Success
* NULL: Failure
@@ -384,6 +393,9 @@
/***********************************************************************
* GlobalLock (KERNEL32.@)
+ *
+ * Lock a global memory object.
+ *
* RETURNS
* Pointer to first byte of block
* NULL: Failure
@@ -429,6 +441,9 @@
/***********************************************************************
* GlobalUnlock (KERNEL32.@)
+ *
+ * Unlock a global memory object.
+ *
* RETURNS
* TRUE: Object is still locked
* FALSE: Object is unlocked
@@ -474,7 +489,8 @@
/***********************************************************************
* GlobalHandle (KERNEL32.@)
- * Returns the handle associated with the specified pointer.
+ *
+ * Get the handle associated with the pointer to a global memory block.
*
* RETURNS
* Handle: Success
@@ -535,6 +551,9 @@
/***********************************************************************
* GlobalReAlloc (KERNEL32.@)
+ *
+ * Change the size or attributes of a global memory object.
+ *
* RETURNS
* Handle: Success
* NULL: Failure
@@ -648,6 +667,9 @@
/***********************************************************************
* GlobalFree (KERNEL32.@)
+ *
+ * Free a global memory object.
+ *
* RETURNS
* NULL: Success
* Handle: Failure
@@ -700,6 +722,9 @@
/***********************************************************************
* GlobalSize (KERNEL32.@)
+ *
+ * Get the size of a global memory object.
+ *
* RETURNS
* Size in bytes of the global memory object
* 0: Failure
@@ -783,7 +808,8 @@
/***********************************************************************
* GlobalFlags (KERNEL32.@)
- * Returns information about the specified global memory object
+ *
+ * Get information about a global memory object.
*
* NOTES
* Should this return GMEM_INVALID_HANDLE on invalid handle?
@@ -834,9 +860,16 @@
/***********************************************************************
* LocalAlloc (KERNEL32.@)
+ *
+ * Allocate a local memory object.
+ *
* RETURNS
* Handle: Success
* NULL: Failure
+ *
+ * NOTES
+ * Windows memory management does not provide a separate local heap
+ * and global heap.
*/
HLOCAL WINAPI LocalAlloc(
UINT flags, /* [in] Allocation attributes */
@@ -857,9 +890,16 @@
/***********************************************************************
* LocalFlags (KERNEL32.@)
+ *
+ * Get information about a local memory object.
+ *
* RETURNS
* Value specifying allocation flags and lock count.
* LMEM_INVALID_HANDLE: Failure
+ *
+ * NOTES
+ * Windows memory management does not provide a separate local heap
+ * and global heap.
*/
UINT WINAPI LocalFlags(
HLOCAL handle /* [in] Handle of memory object */
@@ -870,9 +910,16 @@
/***********************************************************************
* LocalFree (KERNEL32.@)
+ *
+ * Free a local memory object.
+ *
* RETURNS
* NULL: Success
* Handle: Failure
+ *
+ * NOTES
+ * Windows memory management does not provide a separate local heap
+ * and global heap.
*/
HLOCAL WINAPI LocalFree(
HLOCAL handle /* [in] Handle of memory object */
@@ -883,12 +930,19 @@
/***********************************************************************
* LocalHandle (KERNEL32.@)
+ *
+ * Get the handle associated with the pointer to a local memory block.
+ *
* RETURNS
* Handle: Success
* NULL: Failure
+ *
+ * NOTES
+ * Windows memory management does not provide a separate local heap
+ * and global heap.
*/
HLOCAL WINAPI LocalHandle(
- LPCVOID ptr /* [in] Address of local memory object */
+ LPCVOID ptr /* [in] Address of local memory block */
) {
return (HLOCAL)GlobalHandle( ptr );
}
@@ -902,6 +956,10 @@
* RETURNS
* Pointer: Success
* NULL: Failure
+ *
+ * NOTES
+ * Windows memory management does not provide a separate local heap
+ * and global heap.
*/
LPVOID WINAPI LocalLock(
HLOCAL handle /* [in] Address of local memory object */
@@ -912,9 +970,16 @@
/***********************************************************************
* LocalReAlloc (KERNEL32.@)
+ *
+ * Change the size or attributes of a local memory object.
+ *
* RETURNS
* Handle: Success
* NULL: Failure
+ *
+ * NOTES
+ * Windows memory management does not provide a separate local heap
+ * and global heap.
*/
HLOCAL WINAPI LocalReAlloc(
HLOCAL handle, /* [in] Handle of memory object */
@@ -936,9 +1001,16 @@
/***********************************************************************
* LocalSize (KERNEL32.@)
+ *
+ * Get the size of a local memory object.
+ *
* RETURNS
* Size: Success
* 0: Failure
+ *
+ * NOTES
+ * Windows memory management does not provide a separate local heap
+ * and global heap.
*/
SIZE_T WINAPI LocalSize(
HLOCAL handle /* [in] Handle of memory object */
@@ -949,9 +1021,16 @@
/***********************************************************************
* LocalUnlock (KERNEL32.@)
+ *
+ * Unlock a local memory object.
+ *
* RETURNS
* TRUE: Object is still locked
* FALSE: Object is unlocked
+ *
+ * NOTES
+ * Windows memory management does not provide a separate local heap
+ * and global heap.
*/
BOOL WINAPI LocalUnlock(
HLOCAL handle /* [in] Handle of memory object */
@@ -966,10 +1045,11 @@
* This is an undocumented KERNEL32 function that
* SMapLS's a GlobalAlloc'ed buffer.
*
- * Input: EDI register: size of buffer to allocate
- * Output: EDI register: pointer to buffer
+ * RETURNS
+ * EDI register: pointer to buffer
*
- * Note: The buffer is preceded by 8 bytes:
+ * NOTES
+ * The buffer is preceded by 8 bytes:
* ...
* edi+0 buffer
* edi-4 SEGPTR to buffer
@@ -978,8 +1058,9 @@
*
* The SEGPTR is used by the caller!
*/
-void WINAPI __regs_AllocMappedBuffer( CONTEXT86 *context )
-{
+void WINAPI __regs_AllocMappedBuffer(
+ CONTEXT86 *context /* [in] EDI register: size of buffer to allocate */
+) {
HGLOBAL handle = GlobalAlloc(0, context->Edi + 8);
DWORD *buffer = (DWORD *)GlobalLock(handle);
DWORD ptr = 0;
@@ -1011,10 +1092,12 @@
*
* Free a buffer allocated by AllocMappedBuffer
*
- * Input: EDI register: pointer to buffer
+ * RETURNS
+ * Nothing.
*/
-void WINAPI __regs_FreeMappedBuffer( CONTEXT86 *context )
-{
+void WINAPI __regs_FreeMappedBuffer(
+ CONTEXT86 *context /* [in] EDI register: pointer to buffer */
+) {
if (context->Edi)
{
DWORD *buffer = (DWORD *)context->Edi - 2;
Index: dlls/kernel/locale.c
===================================================================
RCS file: /home/wine/wine/dlls/kernel/locale.c,v
retrieving revision 1.68
diff -u -r1.68 locale.c
--- dlls/kernel/locale.c 17 Oct 2005 08:56:41 -0000 1.68
+++ dlls/kernel/locale.c 8 Nov 2005 05:57:26 -0000
@@ -1766,7 +1766,7 @@
* lcid [I] LCID of the locale to check
* flags [I] LCID_SUPPORTED = Valid, LCID_INSTALLED = Valid and installed on the system
*
- * RETURN
+ * RETURNS
* TRUE, if lcid is valid,
* FALSE, otherwise.
*
Index: dlls/kernel/module.c
===================================================================
RCS file: /home/wine/wine/dlls/kernel/module.c,v
retrieving revision 1.20
diff -u -r1.20 module.c
--- dlls/kernel/module.c 18 Oct 2005 14:10:56 -0000 1.20
+++ dlls/kernel/module.c 8 Nov 2005 05:57:26 -0000
@@ -456,6 +456,8 @@
/***********************************************************************
* GetBinaryTypeA [KERNEL32.@]
* GetBinaryType [KERNEL32.@]
+ *
+ * See GetBinaryTypeW.
*/
BOOL WINAPI GetBinaryTypeA( LPCSTR lpApplicationName, LPDWORD lpBinaryType )
{
Index: dlls/kernel/path.c
===================================================================
RCS file: /home/wine/wine/dlls/kernel/path.c,v
retrieving revision 1.25
diff -u -r1.25 path.c
--- dlls/kernel/path.c 26 Sep 2005 13:26:40 -0000 1.25
+++ dlls/kernel/path.c 8 Nov 2005 05:57:27 -0000
@@ -810,6 +810,8 @@
/***********************************************************************
* SearchPathA (KERNEL32.@)
+ *
+ * See SearchPathW.
*/
DWORD WINAPI SearchPathA( LPCSTR path, LPCSTR name, LPCSTR ext,
DWORD buflen, LPSTR buffer, LPSTR *lastpart )
Index: dlls/kernel/string.c
===================================================================
RCS file: /home/wine/wine/dlls/kernel/string.c,v
retrieving revision 1.12
diff -u -r1.12 string.c
--- dlls/kernel/string.c 22 Feb 2005 15:50:14 -0000 1.12
+++ dlls/kernel/string.c 8 Nov 2005 05:57:27 -0000
@@ -170,8 +170,8 @@
/***********************************************************************
- * lstrcat (KERNEL32.@)
* lstrcatA (KERNEL32.@)
+ * lstrcat (KERNEL32.@)
*/
LPSTR WINAPI lstrcatA( LPSTR dst, LPCSTR src )
{
@@ -234,8 +234,8 @@
/***********************************************************************
- * lstrcpy (KERNEL32.@)
* lstrcpyA (KERNEL32.@)
+ * lstrcpy (KERNEL32.@)
*/
LPSTR WINAPI lstrcpyA( LPSTR dst, LPCSTR src )
{
@@ -284,8 +284,8 @@
/***********************************************************************
- * lstrcpyn (KERNEL32.@)
* lstrcpynA (KERNEL32.@)
+ * lstrcpyn (KERNEL32.@)
*
* Note: this function differs from the UNIX strncpy, it _always_ writes
* a terminating \0.
@@ -362,8 +362,8 @@
/***********************************************************************
- * lstrlen (KERNEL32.@)
* lstrlenA (KERNEL32.@)
+ * lstrlen (KERNEL32.@)
*/
INT WINAPI lstrlenA( LPCSTR str )
{
Index: dlls/kernel/sync.c
===================================================================
RCS file: /home/wine/wine/dlls/kernel/sync.c,v
retrieving revision 1.90
diff -u -r1.90 sync.c
--- dlls/kernel/sync.c 6 Oct 2005 11:32:53 -0000 1.90
+++ dlls/kernel/sync.c 8 Nov 2005 05:57:27 -0000
@@ -1596,6 +1596,8 @@
/******************************************************************************
* CreateMailslotA [KERNEL32.@]
+ *
+ * See CreatMailslotW.
*/
HANDLE WINAPI CreateMailslotA( LPCSTR lpName, DWORD nMaxMessageSize,
DWORD lReadTimeout, LPSECURITY_ATTRIBUTES sa )
Index: dlls/kernel/thread.c
===================================================================
RCS file: /home/wine/wine/dlls/kernel/thread.c,v
retrieving revision 1.31
diff -u -r1.31 thread.c
--- dlls/kernel/thread.c 12 Sep 2005 22:01:33 -0000 1.31
+++ dlls/kernel/thread.c 8 Nov 2005 05:57:27 -0000
@@ -649,6 +649,9 @@
* SetLastError (KERNEL32.@)
*
* Sets the last-error code.
+ *
+ * RETURNS
+ * Nothing.
*/
void WINAPI SetLastError( DWORD error ) /* [in] Per-thread error code */
{
@@ -659,7 +662,10 @@
* GetLastError (KERNEL.148)
* GetLastError (KERNEL32.@)
*
- * Returns last-error code.
+ * Get the last-error code.
+ *
+ * RETURNS
+ * last-error code.
*/
DWORD WINAPI GetLastError(void)
{
@@ -670,7 +676,10 @@
* GetCurrentProcessId (KERNEL.471)
* GetCurrentProcessId (KERNEL32.@)
*
- * Returns process identifier.
+ * Get the current process identifier.
+ *
+ * RETURNS
+ * current process identifier
*/
DWORD WINAPI GetCurrentProcessId(void)
{
@@ -681,7 +690,10 @@
* GetCurrentThreadId (KERNEL.462)
* GetCurrentThreadId (KERNEL32.@)
*
- * Returns thread identifier.
+ * Get the current thread identifier.
+ *
+ * RETURNS
+ * current thread identifier
*/
DWORD WINAPI GetCurrentThreadId(void)
{
Index: dlls/kernel/thunk.c
===================================================================
RCS file: /home/wine/wine/dlls/kernel/thunk.c,v
retrieving revision 1.62
diff -u -r1.62 thunk.c
--- dlls/kernel/thunk.c 12 Sep 2005 14:12:47 -0000 1.62
+++ dlls/kernel/thunk.c 8 Nov 2005 05:57:28 -0000
@@ -996,6 +996,9 @@
* 00: DWORD length
* 04: SEGPTR address for thunkbuffer pointer
* [ok probably]
+ *
+ * RETURNS
+ * Nothing.
*/
VOID WINAPI ThunkInitSL(
LPBYTE thunk, /* [in] start of thunkbuffer */
@@ -1055,6 +1058,9 @@
*
* And YES, I've seen nr=48 (somewhere in the Win95 32<->16 OLE coupling)
* [ok]
+ *
+ * RETURNS
+ * Thunked function result.
*/
DWORD WINAPIV SSCall(
DWORD nr, /* [in] number of argument bytes */
@@ -1129,6 +1135,8 @@
/**********************************************************************
* AllocSLCallback (KERNEL32.@)
*
+ * Allocate a 16->32 callback.
+ *
* NOTES
* Win95 uses some structchains for callbacks. It allocates them
* in blocks of 100 entries, size 32 bytes each, layout:
@@ -1182,6 +1190,9 @@
/**********************************************************************
* FreeSLCallback (KERNEL32.@)
* Frees the specified 16->32 callback
+ *
+ * RETURNS
+ * Nothing.
*/
void WINAPI
FreeSLCallback(
Index: dlls/kernel/time.c
===================================================================
RCS file: /home/wine/wine/dlls/kernel/time.c,v
retrieving revision 1.56
diff -u -r1.56 time.c
--- dlls/kernel/time.c 31 Oct 2005 10:04:57 -0000 1.56
+++ dlls/kernel/time.c 8 Nov 2005 05:57:28 -0000
@@ -592,7 +592,6 @@
/*********************************************************************
* GetCalendarInfoW (KERNEL32.@)
*
- * See GetCalendarInfoA.
*/
int WINAPI GetCalendarInfoW(LCID Locale, CALID Calendar, CALTYPE CalType,
LPWSTR lpCalData, int cchData, LPDWORD lpValue)
@@ -736,7 +735,7 @@
/*********************************************************************
* SetCalendarInfoW (KERNEL32.@)
*
- * See SetCalendarInfoA.
+ *
*/
int WINAPI SetCalendarInfoW(LCID Locale, CALID Calendar, CALTYPE CalType, LPCWSTR lpCalData)
{
Index: dlls/kernel/virtual.c
===================================================================
RCS file: /home/wine/wine/dlls/kernel/virtual.c,v
retrieving revision 1.10
diff -u -r1.10 virtual.c
--- dlls/kernel/virtual.c 30 Sep 2005 10:33:43 -0000 1.10
+++ dlls/kernel/virtual.c 8 Nov 2005 05:57:28 -0000
@@ -78,6 +78,10 @@
* VirtualAllocEx (KERNEL32.@)
*
* Seems to be just as VirtualAlloc, but with process handle.
+ *
+ * RETURNS
+ * Base address of allocated region of pages
+ * NULL: Failure
*/
LPVOID WINAPI VirtualAllocEx(
HANDLE hProcess, /* [in] Handle of process to do mem operation */
@@ -286,7 +290,7 @@
/***********************************************************************
* CreateFileMappingW (KERNEL32.@)
- * See CreateFileMappingA
+ * See CreateFileMappingA.
*/
HANDLE WINAPI CreateFileMappingW( HANDLE hFile, LPSECURITY_ATTRIBUTES sa,
DWORD protect, DWORD size_high,
@@ -383,7 +387,7 @@
/***********************************************************************
* OpenFileMappingW (KERNEL32.@)
- * See OpenFileMappingA
+ * See OpenFileMappingA.
*/
HANDLE WINAPI OpenFileMappingW( DWORD access, BOOL inherit, LPCWSTR name)
{
@@ -517,6 +521,8 @@
/***********************************************************************
* IsBadReadPtr (KERNEL32.@)
*
+ * Check for read access on a memory block.
+ *
* RETURNS
* FALSE: Process has read access to entire block
* TRUE: Otherwise
@@ -557,6 +563,8 @@
/***********************************************************************
* IsBadWritePtr (KERNEL32.@)
*
+ * Check for write access on a memory block.
+ *
* RETURNS
* FALSE: Process has write access to entire block
* TRUE: Otherwise
@@ -595,6 +603,9 @@
/***********************************************************************
* IsBadHugeReadPtr (KERNEL32.@)
+ *
+ * Check for read access on a memory block.
+ *
* RETURNS
* FALSE: Process has read access to entire block
* TRUE: Otherwise
@@ -609,6 +620,9 @@
/***********************************************************************
* IsBadHugeWritePtr (KERNEL32.@)
+ *
+ * Check for write access on a memory block.
+ *
* RETURNS
* FALSE: Process has write access to entire block
* TRUE: Otherwise
@@ -624,6 +638,8 @@
/***********************************************************************
* IsBadCodePtr (KERNEL32.@)
*
+ * Check for read access on a memory address.
+ *
* RETURNS
* FALSE: Process has read access to specified memory
* TRUE: Otherwise
@@ -637,6 +653,8 @@
/***********************************************************************
* IsBadStringPtrA (KERNEL32.@)
*
+ * Check for read access on a range of memory pointed to by a string pointer.
+ *
* RETURNS
* FALSE: Read access to all bytes in string
* TRUE: Else
@@ -664,7 +682,7 @@
/***********************************************************************
* IsBadStringPtrW (KERNEL32.@)
- * See IsBadStringPtrA
+ * See IsBadStringPtrA.
*/
BOOL WINAPI IsBadStringPtrW( LPCWSTR str, UINT max )
{
Index: dlls/kernel/volume.c
===================================================================
RCS file: /home/wine/wine/dlls/kernel/volume.c,v
retrieving revision 1.33
diff -u -r1.33 volume.c
--- dlls/kernel/volume.c 20 Oct 2005 11:36:40 -0000 1.33
+++ dlls/kernel/volume.c 8 Nov 2005 05:57:29 -0000
@@ -1240,6 +1240,8 @@
/***********************************************************************
* GetDriveTypeA (KERNEL32.@)
+ *
+ * See GetDriveTypeW.
*/
UINT WINAPI GetDriveTypeA( LPCSTR root )
{
@@ -1294,6 +1296,8 @@
/***********************************************************************
* GetDiskFreeSpaceExA (KERNEL32.@)
+ *
+ * See GetDiskFreeSpaceExW.
*/
BOOL WINAPI GetDiskFreeSpaceExA( LPCSTR root, PULARGE_INTEGER avail,
PULARGE_INTEGER total, PULARGE_INTEGER totalfree )
More information about the wine-patches
mailing list