From ae542af541ecd31b03f6d7519c1a052934980f10 Mon Sep 17 00:00:00 2001 From: Markus Amsler Date: Wed, 9 Nov 2005 10:30:57 +0000 Subject: [PATCH] Improve c2man Documented-Total count. --- dlls/ntdll/error.c | 6 ++++++ dlls/ntdll/reg.c | 6 +++--- dlls/ntdll/sec.c | 4 ++-- dlls/ntdll/string.c | 3 +++ dlls/ole32/clipboard.c | 2 +- dlls/ole32/memlockbytes16.c | 4 ++-- dlls/ole32/ole16.c | 10 ++++++++-- dlls/ole32/ole2.c | 14 ++++++++------ dlls/ole32/storage.c | 7 ++++++- dlls/ole32/storage32.c | 11 ++++++++++- 10 files changed, 49 insertions(+), 18 deletions(-) diff --git a/dlls/ntdll/error.c b/dlls/ntdll/error.c index 4bcf5aff161..161f675b000 100644 --- a/dlls/ntdll/error.c +++ b/dlls/ntdll/error.c @@ -132,6 +132,9 @@ DWORD WINAPI RtlGetLastWin32Error(void) * * PARAMS * err [I] The new error value to set + * + * RETURNS + * Nothing. */ void WINAPI RtlSetLastWin32Error( DWORD err ) { @@ -145,6 +148,9 @@ void WINAPI RtlSetLastWin32Error( DWORD err ) * * PARAMS * err [I] The new status value to set + * + * RETURNS + * Nothing. */ void WINAPI RtlSetLastWin32ErrorAndNtStatusFromNtStatus( NTSTATUS status ) { diff --git a/dlls/ntdll/reg.c b/dlls/ntdll/reg.c index 5fc81b3f94a..584c82498ba 100644 --- a/dlls/ntdll/reg.c +++ b/dlls/ntdll/reg.c @@ -837,9 +837,9 @@ NTSTATUS WINAPI RtlFormatCurrentUserKeyPath( IN OUT PUNICODE_STRING KeyPath) /****************************************************************************** * 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] */ diff --git a/dlls/ntdll/sec.c b/dlls/ntdll/sec.c index 7636d5ebe43..4133cdcf44e 100644 --- a/dlls/ntdll/sec.c +++ b/dlls/ntdll/sec.c @@ -414,7 +414,7 @@ BOOLEAN WINAPI RtlValidSid( PSID pSid ) * 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 @@ NTSTATUS WINAPI RtlCreateSecurityDescriptor( * pSourceSD [O] SD to copy from. * pDestinationSD [I] Destination SD. * - * RETURNS: + * RETURNS * Success: STATUS_SUCCESS. * Failure: STATUS_UNKNOWN_REVISION if rev is incorrect. */ diff --git a/dlls/ntdll/string.c b/dlls/ntdll/string.c index 5e48eb85834..e05f7c33187 100644 --- a/dlls/ntdll/string.c +++ b/dlls/ntdll/string.c @@ -382,6 +382,9 @@ LONGLONG __cdecl _atoi64( char *str ) * 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 ) diff --git a/dlls/ole32/clipboard.c b/dlls/ole32/clipboard.c index 06ffba67ff9..61c9441a0b8 100644 --- a/dlls/ole32/clipboard.c +++ b/dlls/ole32/clipboard.c @@ -303,7 +303,7 @@ typedef struct tagClipboardWindowInfo * Places a pointer to the specified data object onto the clipboard, * making the data object accessible to the OleGetClipboard function. * - * RETURNS: + * RETURNS * * S_OK IDataObject pointer placed on the clipboard * CLIPBRD_E_CANT_OPEN OpenClipboard failed diff --git a/dlls/ole32/memlockbytes16.c b/dlls/ole32/memlockbytes16.c index d2c65989c7a..61078f8fede 100644 --- a/dlls/ole32/memlockbytes16.c +++ b/dlls/ole32/memlockbytes16.c @@ -500,12 +500,12 @@ HRESULT HGLOBALLockBytesImpl16_Stat( * * Creates an ILockBytes interface for a HGLOBAL handle. * - * Params: + * PARAMS * hGlobal the global handle (16bit) * fDeleteOnRelease delete handle on release. * ppLkbyt pointer to ILockBytes interface. * - * Returns: + * RETURNS * Staddard OLE error return codes. * */ diff --git a/dlls/ole32/ole16.c b/dlls/ole32/ole16.c index b70d55a1c40..f7d76f36e3a 100644 --- a/dlls/ole32/ole16.c +++ b/dlls/ole32/ole16.c @@ -204,6 +204,9 @@ IMalloc16_Constructor() /*********************************************************************** * CoGetMalloc [COMPOBJ.4] + * + * Retrieve the current win16 IMalloc interface. + * * RETURNS * The current win16 IMalloc */ @@ -344,9 +347,12 @@ HRESULT WINAPI StringFromCLSID16( /****************************************************************************** * ProgIDFromCLSID [COMPOBJ.62] + * * Converts a class id into the respective Program ID. (By using a registry lookup) - * RETURNS S_OK on success - * riid associated with the progid + * + * RETURNS + * S_OK on success + * riid associated with the progid */ HRESULT WINAPI ProgIDFromCLSID16( REFCLSID clsid, /* [in] class id as found in registry */ diff --git a/dlls/ole32/ole2.c b/dlls/ole32/ole2.c index 13ebc38a58d..0363f1332ca 100644 --- a/dlls/ole32/ole2.c +++ b/dlls/ole32/ole2.c @@ -1553,21 +1553,23 @@ HRESULT WINAPI OleDestroyMenuDescriptor( /*********************************************************************** * OleSetMenuDescriptor [OLE32.@] - * Installs or removes OLE dispatching code for the containers frame window - * FIXME: The lpFrame and lpActiveObject parameters are currently ignored - * OLE should install context sensitive help F1 filtering for the app when - * these are non null. + * Installs or removes OLE dispatching code for the containers frame window. * - * PARAMS: + * PARAMS * hOleMenu Handle to composite menu descriptor * hwndFrame Handle to containers frame window * hwndActiveObject Handle to objects in-place activation window * lpFrame Pointer to IOleInPlaceFrame on containers window * lpActiveObject Pointer to IOleInPlaceActiveObject on active in-place object * - * RETURNS: + * RETURNS * S_OK - menu installed correctly * E_FAIL, E_INVALIDARG, E_UNEXPECTED - failure + * + * FIXME + * The lpFrame and lpActiveObject parameters are currently ignored + * OLE should install context sensitive help F1 filtering for the app when + * these are non null. */ HRESULT WINAPI OleSetMenuDescriptor( HOLEMENU hOleMenu, diff --git a/dlls/ole32/storage.c b/dlls/ole32/storage.c index 2129c770f30..d1bd1933727 100644 --- a/dlls/ole32/storage.c +++ b/dlls/ole32/storage.c @@ -2227,7 +2227,12 @@ HRESULT WINAPI StgOpenStorageOnILockBytes16( * the WriteClassStg. * * PARAMS - * pstg Segmented LPSTORAGE pointer. + * pstg [I] Segmented LPSTORAGE pointer. + * pclsid [O] Pointer to where the CLSID is written + * + * RETURNS + * Success: S_OK. + * Failure: HRESULT code. */ HRESULT WINAPI ReadClassStg16(SEGPTR pstg, CLSID *pclsid) { diff --git a/dlls/ole32/storage32.c b/dlls/ole32/storage32.c index d1360d95bdf..708d99442e2 100644 --- a/dlls/ole32/storage32.c +++ b/dlls/ole32/storage32.c @@ -6140,7 +6140,16 @@ HRESULT WINAPI WriteClassStg(IStorage* pStg, REFCLSID rclsid) /*********************************************************************** * ReadClassStg (OLE32.@) * - * This method reads the CLSID previously written to a storage object with the WriteClassStg. + * This method reads the CLSID previously written to a storage object with + * the WriteClassStg. + * + * PARAMS + * pstg [I] IStorage pointer + * pclsid [O] Pointer to where the CLSID is written + * + * RETURNS + * Success: S_OK. + * Failure: HRESULT code. */ HRESULT WINAPI ReadClassStg(IStorage *pstg,CLSID *pclsid){ -- 2.11.4.GIT