Improve c2man Documented-Total count.

This commit is contained in:
Markus Amsler 2005-11-09 10:30:57 +00:00 committed by Alexandre Julliard
parent 0acf88651d
commit ae542af541
10 changed files with 49 additions and 18 deletions

View File

@ -132,6 +132,9 @@ DWORD WINAPI RtlGetLastWin32Error(void)
* *
* PARAMS * PARAMS
* err [I] The new error value to set * err [I] The new error value to set
*
* RETURNS
* Nothing.
*/ */
void WINAPI RtlSetLastWin32Error( DWORD err ) void WINAPI RtlSetLastWin32Error( DWORD err )
{ {
@ -145,6 +148,9 @@ void WINAPI RtlSetLastWin32Error( DWORD err )
* *
* PARAMS * PARAMS
* err [I] The new status value to set * err [I] The new status value to set
*
* RETURNS
* Nothing.
*/ */
void WINAPI RtlSetLastWin32ErrorAndNtStatusFromNtStatus( NTSTATUS status ) void WINAPI RtlSetLastWin32ErrorAndNtStatusFromNtStatus( NTSTATUS status )
{ {

View File

@ -837,9 +837,9 @@ NTSTATUS WINAPI RtlFormatCurrentUserKeyPath( IN OUT PUNICODE_STRING KeyPath)
/****************************************************************************** /******************************************************************************
* RtlOpenCurrentUser [NTDLL.@] * RtlOpenCurrentUser [NTDLL.@]
* *
* if we return just HKEY_CURRENT_USER the advapi tries to find a remote * NOTES
* registry (odd handle) and fails * If we return just HKEY_CURRENT_USER the advapi tries to find a remote
* * registry (odd handle) and fails.
*/ */
DWORD WINAPI RtlOpenCurrentUser( DWORD WINAPI RtlOpenCurrentUser(
IN ACCESS_MASK DesiredAccess, /* [in] */ IN ACCESS_MASK DesiredAccess, /* [in] */

View File

@ -414,7 +414,7 @@ BOOLEAN WINAPI RtlValidSid( PSID pSid )
* lpsd [O] Descriptor to initialise. * lpsd [O] Descriptor to initialise.
* rev [I] Revision, must be set to SECURITY_DESCRIPTOR_REVISION. * rev [I] Revision, must be set to SECURITY_DESCRIPTOR_REVISION.
* *
* RETURNS: * RETURNS
* Success: STATUS_SUCCESS. * Success: STATUS_SUCCESS.
* Failure: STATUS_UNKNOWN_REVISION if rev is incorrect. * Failure: STATUS_UNKNOWN_REVISION if rev is incorrect.
*/ */
@ -438,7 +438,7 @@ NTSTATUS WINAPI RtlCreateSecurityDescriptor(
* pSourceSD [O] SD to copy from. * pSourceSD [O] SD to copy from.
* pDestinationSD [I] Destination SD. * pDestinationSD [I] Destination SD.
* *
* RETURNS: * RETURNS
* Success: STATUS_SUCCESS. * Success: STATUS_SUCCESS.
* Failure: STATUS_UNKNOWN_REVISION if rev is incorrect. * Failure: STATUS_UNKNOWN_REVISION if rev is incorrect.
*/ */

View File

@ -382,6 +382,9 @@ LONGLONG __cdecl _atoi64( char *str )
* dir [O] Destination for directory component. Should be at least MAX_PATH characters. * 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. * 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. * 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, void __cdecl _splitpath(const char* inpath, char * drv, char * dir,
char* fname, char * ext ) char* fname, char * ext )

View File

@ -303,7 +303,7 @@ typedef struct tagClipboardWindowInfo
* Places a pointer to the specified data object onto the clipboard, * Places a pointer to the specified data object onto the clipboard,
* making the data object accessible to the OleGetClipboard function. * making the data object accessible to the OleGetClipboard function.
* *
* RETURNS: * RETURNS
* *
* S_OK IDataObject pointer placed on the clipboard * S_OK IDataObject pointer placed on the clipboard
* CLIPBRD_E_CANT_OPEN OpenClipboard failed * CLIPBRD_E_CANT_OPEN OpenClipboard failed

View File

@ -500,12 +500,12 @@ HRESULT HGLOBALLockBytesImpl16_Stat(
* *
* Creates an ILockBytes interface for a HGLOBAL handle. * Creates an ILockBytes interface for a HGLOBAL handle.
* *
* Params: * PARAMS
* hGlobal the global handle (16bit) * hGlobal the global handle (16bit)
* fDeleteOnRelease delete handle on release. * fDeleteOnRelease delete handle on release.
* ppLkbyt pointer to ILockBytes interface. * ppLkbyt pointer to ILockBytes interface.
* *
* Returns: * RETURNS
* Staddard OLE error return codes. * Staddard OLE error return codes.
* *
*/ */

View File

@ -204,6 +204,9 @@ IMalloc16_Constructor()
/*********************************************************************** /***********************************************************************
* CoGetMalloc [COMPOBJ.4] * CoGetMalloc [COMPOBJ.4]
*
* Retrieve the current win16 IMalloc interface.
*
* RETURNS * RETURNS
* The current win16 IMalloc * The current win16 IMalloc
*/ */
@ -344,9 +347,12 @@ HRESULT WINAPI StringFromCLSID16(
/****************************************************************************** /******************************************************************************
* ProgIDFromCLSID [COMPOBJ.62] * ProgIDFromCLSID [COMPOBJ.62]
*
* Converts a class id into the respective Program ID. (By using a registry lookup) * 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( HRESULT WINAPI ProgIDFromCLSID16(
REFCLSID clsid, /* [in] class id as found in registry */ REFCLSID clsid, /* [in] class id as found in registry */

View File

@ -1553,21 +1553,23 @@ HRESULT WINAPI OleDestroyMenuDescriptor(
/*********************************************************************** /***********************************************************************
* OleSetMenuDescriptor [OLE32.@] * OleSetMenuDescriptor [OLE32.@]
* Installs or removes OLE dispatching code for the containers frame window * 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.
* *
* PARAMS: * PARAMS
* hOleMenu Handle to composite menu descriptor * hOleMenu Handle to composite menu descriptor
* hwndFrame Handle to containers frame window * hwndFrame Handle to containers frame window
* hwndActiveObject Handle to objects in-place activation window * hwndActiveObject Handle to objects in-place activation window
* lpFrame Pointer to IOleInPlaceFrame on containers window * lpFrame Pointer to IOleInPlaceFrame on containers window
* lpActiveObject Pointer to IOleInPlaceActiveObject on active in-place object * lpActiveObject Pointer to IOleInPlaceActiveObject on active in-place object
* *
* RETURNS: * RETURNS
* S_OK - menu installed correctly * S_OK - menu installed correctly
* E_FAIL, E_INVALIDARG, E_UNEXPECTED - failure * 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( HRESULT WINAPI OleSetMenuDescriptor(
HOLEMENU hOleMenu, HOLEMENU hOleMenu,

View File

@ -2227,7 +2227,12 @@ HRESULT WINAPI StgOpenStorageOnILockBytes16(
* the WriteClassStg. * the WriteClassStg.
* *
* PARAMS * 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) HRESULT WINAPI ReadClassStg16(SEGPTR pstg, CLSID *pclsid)
{ {

View File

@ -6140,7 +6140,16 @@ HRESULT WINAPI WriteClassStg(IStorage* pStg, REFCLSID rclsid)
/*********************************************************************** /***********************************************************************
* ReadClassStg (OLE32.@) * 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){ HRESULT WINAPI ReadClassStg(IStorage *pstg,CLSID *pclsid){