ntdll: improve c2man documentation

Markus Amsler markus.amsler at oribi.org
Tue Nov 8 17:38:21 CST 2005


Found 4 missing RETURNS sections for ntdll.

Changelog:
  Markus Amsler <markus.amsler at oribi.org>
  Improve c2man Documented-Total count.

-------------- next part --------------
Index: dlls/ntdll/error.c
===================================================================
RCS file: /home/wine/wine/dlls/ntdll/error.c,v
retrieving revision 1.17
diff -u -r1.17 error.c
--- dlls/ntdll/error.c	28 Jul 2005 18:40:45 -0000	1.17
+++ dlls/ntdll/error.c	8 Nov 2005 23:41:13 -0000
@@ -132,6 +132,9 @@
  *
  * PARAMS
  *  err [I] The new error value to set
+ *
+ * RETURNS
+ *  Nothing.
  */
 void WINAPI RtlSetLastWin32Error( DWORD err )
 {
@@ -145,6 +148,9 @@
  *
  * PARAMS
  *  err [I] The new status value to set
+ *
+ * RETURNS
+ *  Nothing.
  */
 void WINAPI RtlSetLastWin32ErrorAndNtStatusFromNtStatus( NTSTATUS status )
 {
Index: dlls/ntdll/reg.c
===================================================================
RCS file: /home/wine/wine/dlls/ntdll/reg.c,v
retrieving revision 1.64
diff -u -r1.64 reg.c
--- dlls/ntdll/reg.c	11 Jul 2005 20:42:12 -0000	1.64
+++ dlls/ntdll/reg.c	8 Nov 2005 23:41:13 -0000
@@ -837,9 +837,9 @@
 /******************************************************************************
  *  RtlOpenCurrentUser		[NTDLL.@]
  *
- * if we return just HKEY_CURRENT_USER the advapi tries to find a remote
- * registry (odd handle) and fails
- *
+ * NOTES
+ *  If we return just HKEY_CURRENT_USER the advapi tries to find a remote
+ *  registry (odd handle) and fails.
  */
 DWORD WINAPI RtlOpenCurrentUser(
 	IN ACCESS_MASK DesiredAccess, /* [in] */
Index: dlls/ntdll/sec.c
===================================================================
RCS file: /home/wine/wine/dlls/ntdll/sec.c,v
retrieving revision 1.66
diff -u -r1.66 sec.c
--- dlls/ntdll/sec.c	12 Sep 2005 15:14:07 -0000	1.66
+++ dlls/ntdll/sec.c	8 Nov 2005 23:41:13 -0000
@@ -414,7 +414,7 @@
  *  lpsd [O] Descriptor to initialise.
  *  rev  [I] Revision, must be set to SECURITY_DESCRIPTOR_REVISION.
  *
- * RETURNS:
+ * RETURNS
  *  Success: STATUS_SUCCESS.
  *  Failure: STATUS_UNKNOWN_REVISION if rev is incorrect.
  */
@@ -438,7 +438,7 @@
  *  pSourceSD      [O] SD to copy from.
  *  pDestinationSD [I] Destination SD.
  *
- * RETURNS:
+ * RETURNS
  *  Success: STATUS_SUCCESS.
  *  Failure: STATUS_UNKNOWN_REVISION if rev is incorrect.
  */
Index: dlls/ntdll/string.c
===================================================================
RCS file: /home/wine/wine/dlls/ntdll/string.c,v
retrieving revision 1.17
diff -u -r1.17 string.c
--- dlls/ntdll/string.c	21 Jun 2005 09:52:41 -0000	1.17
+++ dlls/ntdll/string.c	8 Nov 2005 23:41:13 -0000
@@ -382,6 +382,9 @@
  *  dir    [O] Destination for directory component. Should be at least MAX_PATH characters.
  *  fname  [O] Destination for File name component. Should be at least MAX_PATH characters.
  *  ext    [O] Destination for file extension component. Should be at least MAX_PATH characters.
+ *
+ * RETURNS
+ *  Nothing.
  */
 void __cdecl _splitpath(const char* inpath, char * drv, char * dir,
                         char* fname, char * ext )


More information about the wine-patches mailing list