Commit bca4a8dc authored by Patrik Stridvall's avatar Patrik Stridvall Committed by Alexandre Julliard

Documentation argument fixes.

parent df75e89d
......@@ -27,8 +27,8 @@ DEFAULT_DEBUG_CHANNEL(debugstr);
* Returns true if a debug event occurred and false if the call timed out.
*/
BOOL WINAPI WaitForDebugEvent(
LPDEBUG_EVENT event, /* Address of structure for event information. */
DWORD timeout /* Number of milliseconds to wait for event. */)
LPDEBUG_EVENT event, /* [out] Address of structure for event information. */
DWORD timeout) /* [in] Number of milliseconds to wait for event. */
{
BOOL ret;
DWORD res;
......@@ -132,9 +132,9 @@ BOOL WINAPI WaitForDebugEvent(
* and thread are valid.
*/
BOOL WINAPI ContinueDebugEvent(
DWORD pid, /* The id of the process to continue. */
DWORD tid, /* The id of the thread to continue. */
DWORD status /* The rule to apply to unhandled exeptions. */)
DWORD pid, /* [in] The id of the process to continue. */
DWORD tid, /* [in] The id of the thread to continue. */
DWORD status) /* [in] The rule to apply to unhandled exeptions. */
{
BOOL ret;
SERVER_START_REQ
......@@ -160,7 +160,7 @@ BOOL WINAPI ContinueDebugEvent(
* True if the debugger was attached to process.
*/
BOOL WINAPI DebugActiveProcess(
DWORD pid /* The process to be debugged. */)
DWORD pid) /* [in] The process to be debugged. */
{
BOOL ret;
SERVER_START_REQ
......@@ -182,7 +182,7 @@ BOOL WINAPI DebugActiveProcess(
* and program log.
*/
void WINAPI OutputDebugStringA(
LPCSTR str /* The message to be logged and given to the debugger. */)
LPCSTR str) /* [in] The message to be logged and given to the debugger. */
{
SERVER_START_REQ
{
......@@ -204,7 +204,7 @@ void WINAPI OutputDebugStringA(
* and program log.
*/
void WINAPI OutputDebugStringW(
LPCWSTR str /* The message to be logged and given to the debugger. */)
LPCWSTR str) /* [in] The message to be logged and given to the debugger. */
{
SERVER_START_REQ
{
......@@ -226,7 +226,7 @@ void WINAPI OutputDebugStringW(
* and program log.
*/
void WINAPI OutputDebugString16(
LPCSTR str /* The message to be logged and given to the debugger.*/)
LPCSTR str) /* [in] The message to be logged and given to the debugger. */
{
OutputDebugStringA( str );
}
......@@ -255,7 +255,7 @@ void WINAPI DebugBreak(void)
* Only 386 compatible processors implemented.
*/
void WINAPI DebugBreak16(
CONTEXT86 *context /* A pointer to the 386 compatible processor state. */)
CONTEXT86 *context) /* [in/out] A pointer to the 386 compatible processor state. */
{
#ifdef __i386__
EXCEPTION_RECORD rec;
......
......@@ -41,7 +41,8 @@ static int TIME_GetBias( time_t utc, int *pdaylight)
* True if the time was set, false if the time was invalid or the
* necessary permissions were not held.
*/
BOOL WINAPI SetLocalTime( const SYSTEMTIME *systime /* The desired local time. */ )
BOOL WINAPI SetLocalTime(
const SYSTEMTIME *systime) /* [in] The desired local time. */
{
struct timeval tv;
struct tm t;
......@@ -98,9 +99,9 @@ BOOL WINAPI SetLocalTime( const SYSTEMTIME *systime /* The desired local time. *
* (also the signature is wrong it should have a return type of BOOL)
*/
DWORD WINAPI GetSystemTimeAdjustment(
LPDWORD lpTimeAdjustment, /* The clock adjustment per interupt in 100's of nanoseconds. */
LPDWORD lpTimeIncrement, /* The time between clock interupts in 100's of nanoseconds. */
LPBOOL lpTimeAdjustmentDisabled /* The clock synchonisation has been disabled. */ )
LPDWORD lpTimeAdjustment, /* [out] The clock adjustment per interupt in 100's of nanoseconds. */
LPDWORD lpTimeIncrement, /* [out] The time between clock interupts in 100's of nanoseconds. */
LPBOOL lpTimeAdjustmentDisabled) /* [out] The clock synchonisation has been disabled. */
{
*lpTimeAdjustment = 0;
*lpTimeIncrement = 0;
......@@ -120,7 +121,7 @@ DWORD WINAPI GetSystemTimeAdjustment(
* necessary permissions were not held.
*/
BOOL WINAPI SetSystemTime(
const SYSTEMTIME *systime /* The desired system time. */)
const SYSTEMTIME *systime) /* [in] The desired system time. */
{
struct timeval tv;
struct timezone tz;
......@@ -181,7 +182,7 @@ BOOL WINAPI SetSystemTime(
* The daylight savings time standard or TIME_ZONE_ID_INVALID if the call failed.
*/
DWORD WINAPI GetTimeZoneInformation(
LPTIME_ZONE_INFORMATION tzinfo /* The time zone structure to be filled in. */)
LPTIME_ZONE_INFORMATION tzinfo) /* [out] The time zone structure to be filled in. */
{
time_t gmt;
int bias, daylight;
......@@ -213,7 +214,7 @@ DWORD WINAPI GetTimeZoneInformation(
* Use the obsolete unix timezone structure and tz_dsttime member.
*/
BOOL WINAPI SetTimeZoneInformation(
const LPTIME_ZONE_INFORMATION tzinfo /* The new time zone. */)
const LPTIME_ZONE_INFORMATION tzinfo) /* [in] The new time zone. */
{
struct timezone tz;
......@@ -241,9 +242,9 @@ BOOL WINAPI SetTimeZoneInformation(
* Does not handle daylight savings time adjustments correctly.
*/
BOOL WINAPI SystemTimeToTzSpecificLocalTime(
LPTIME_ZONE_INFORMATION lpTimeZoneInformation, /* The desired time zone. */
LPSYSTEMTIME lpUniversalTime, /* The utc time to base local time on. */
LPSYSTEMTIME lpLocalTime /* The local time in the time zone. */)
LPTIME_ZONE_INFORMATION lpTimeZoneInformation, /* [in] The desired time zone. */
LPSYSTEMTIME lpUniversalTime, /* [in] The utc time to base local time on. */
LPSYSTEMTIME lpLocalTime) /* [out] The local time in the time zone. */
{
FIXME(":stub\n");
SetLastError(ERROR_CALL_NOT_IMPLEMENTED);
......@@ -257,7 +258,7 @@ BOOL WINAPI SystemTimeToTzSpecificLocalTime(
* Fills in a file time structure with the current time in UTC format.
*/
VOID WINAPI GetSystemTimeAsFileTime(
LPFILETIME time /* The file time struct to be filled with the system time. */)
LPFILETIME time) /* [out] The file time struct to be filled with the system time. */
{
NtQuerySystemTime( (LARGE_INTEGER *)time );
}
......@@ -298,11 +299,11 @@ static void TIME_ClockTimeToFileTime(clock_t unix_time, LPFILETIME filetime)
* lpCreationTime, lpExitTime are NOT INITIALIZED.
*/
BOOL WINAPI GetProcessTimes(
HANDLE hprocess, /* The process to be queried (obtained from PROCESS_QUERY_INFORMATION). */
LPFILETIME lpCreationTime, /* The creation time of the process. */
LPFILETIME lpExitTime, /* The exit time of the process if exited. */
LPFILETIME lpKernelTime, /* The time spent in kernal routines in 100's of nanoseconds. */
LPFILETIME lpUserTime /* The time spent in user routines in 100's of nanoseconds. */)
HANDLE hprocess, /* [in] The process to be queried (obtained from PROCESS_QUERY_INFORMATION). */
LPFILETIME lpCreationTime, /* [out] The creation time of the process. */
LPFILETIME lpExitTime, /* [out] The exit time of the process if exited. */
LPFILETIME lpKernelTime, /* [out] The time spent in kernal routines in 100's of nanoseconds. */
LPFILETIME lpUserTime) /* [out] The time spent in user routines in 100's of nanoseconds. */
{
struct tms tms;
......
......@@ -37,16 +37,15 @@ DECLARE_DEBUG_CHANNEL(typelib);
*
* S_OK on success.
*/
HRESULT WINAPI
DispInvoke(VOID* _this, /* object instance */
ITypeInfo* ptinfo, /* object's type info */
DISPID dispidMember, /* member id */
USHORT wFlags, /* kind of method call */
DISPPARAMS* pparams, /* array of arguments */
VARIANT* pvarResult, /* result of method call */
EXCEPINFO* pexcepinfo, /* information about exception */
UINT* puArgErr /* index of bad argument(if any) */
)
HRESULT WINAPI DispInvoke(
VOID *_this, /* [in] object instance */
ITypeInfo *ptinfo, /* [in] object's type info */
DISPID dispidMember, /* [in] member id */
USHORT wFlags, /* [in] kind of method call */
DISPPARAMS *pparams, /* [in] array of arguments */
VARIANT *pvarResult, /* [out] result of method call */
EXCEPINFO *pexcepinfo, /* [out] information about exception */
UINT *puArgErr) /* [out] index of bad argument(if any) */
{
HRESULT hr = E_FAIL;
......@@ -80,11 +79,11 @@ DispInvoke(VOID* _this, /* object instance */
*
* S_OK on success.
*/
HRESULT WINAPI
DispGetIDsOfNames(ITypeInfo* ptinfo,
OLECHAR** rgszNames,
UINT cNames,
DISPID* rgdispid)
HRESULT WINAPI DispGetIDsOfNames(
ITypeInfo *ptinfo, /* [in] */
OLECHAR **rgszNames, /* [in] */
UINT cNames, /* [in] */
DISPID *rgdispid) /* [out] */
{
HRESULT hr = E_FAIL;
......@@ -97,7 +96,7 @@ DispGetIDsOfNames(ITypeInfo* ptinfo,
}
/******************************************************************************
* DispGetParam (OLEAUT32.30)
* DispGetParam (OLEAUT32.28)
*
* Retrive a parameter from a DISPPARAMS structures and coerce it to
* specified variant type
......@@ -109,10 +108,12 @@ DispGetIDsOfNames(ITypeInfo* ptinfo,
*
* S_OK on success.
*/
HRESULT WINAPI
DispGetParam(DISPPARAMS* pdispparams,
UINT position,
VARTYPE vtTarg)
HRESULT WINAPI DispGetParam(
DISPPARAMS *pdispparams, /* [in] */
UINT position, /* [in] */
VARTYPE vtTarg, /* [in] */
VARIANT *pvarResult, /* [out] */
UINT *puArgErr) /* [out] */
{
HRESULT hr = E_FAIL;
......
......@@ -339,13 +339,13 @@ HANDLE FILE_CreateDevice( int client_id, DWORD access, LPSECURITY_ATTRIBUTES sa
*
* PARAMS
*
* filename [I] pointer to filename to be accessed
* access [I] access mode requested
* sharing [I] share mode
* sa [I] pointer to security attributes
* creation [I] how to create the file
* attributes [I] attributes for newly created file
* template [I] handle to file with extended attributes to copy
* filename [in] pointer to filename to be accessed
* access [in] access mode requested
* sharing [in] share mode
* sa [in] pointer to security attributes
* creation [in] how to create the file
* attributes [in] attributes for newly created file
* template [in] handle to file with extended attributes to copy
*
* RETURNS
* Success: Open handle to specified file
......@@ -1141,10 +1141,10 @@ HFILE WINAPI _lclose( HFILE hFile )
*
*/
BOOL WINAPI GetOverlappedResult(
HANDLE hFile, /* [I] handle of file to check on */
LPOVERLAPPED lpOverlapped, /* [I/O] pointer to overlapped */
LPDWORD lpTransferred, /* [I/O] number of bytes transfered */
BOOL bWait /* [I] wait for the transfer to complete ? */
HANDLE hFile, /* [in] handle of file to check on */
LPOVERLAPPED lpOverlapped, /* [in/out] pointer to overlapped */
LPDWORD lpTransferred, /* [in/out] number of bytes transfered */
BOOL bWait /* [in] wait for the transfer to complete ? */
) {
DWORD r;
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment