Correct and complete some api documentation.
authorVincent Béron <vberon@mecano.gme.usherb.ca>
Mon, 21 Mar 2005 10:55:13 +0000 (10:55 +0000)
committerAlexandre Julliard <julliard@winehq.org>
Mon, 21 Mar 2005 10:55:13 +0000 (10:55 +0000)
dlls/avifil32/api.c
dlls/itss/itss.c
dlls/ole32/compobj.c
dlls/twain/twain16_main.c
dlls/winmm/mmsystem.c

index 5e22f6f81bd293177c42267d8da04abe12cad4bb..8be7900edc86010771a7f968c7871799731b12c6 100644 (file)
@@ -190,6 +190,7 @@ void WINAPI AVIFileExit(void) {
 }
 
 /***********************************************************************
+ *             AVIFileOpen             (AVIFIL32.@)
  *             AVIFileOpenA            (AVIFIL32.@)
  *             AVIFileOpen             (AVIFILE.102)
  */
@@ -363,6 +364,7 @@ HRESULT WINAPI AVIFileGetStream(PAVIFILE pfile, PAVISTREAM *avis,
 }
 
 /***********************************************************************
+ *             AVIFileCreateStream     (AVIFIL32.@)
  *             AVIFileCreateStreamA    (AVIFIL32.@)
  *              AVIFileCreateStream    (AVIFILE.144)
  */
@@ -782,8 +784,9 @@ HRESULT WINAPI AVIMakeFileFromStreams(PAVIFILE *ppfile, int nStreams,
 }
 
 /***********************************************************************
- *             AVIStreamOpenFromFile   (AVIFILE.103)
+ *             AVIStreamOpenFromFile   (AVIFIL32.@)
  *             AVIStreamOpenFromFileA  (AVIFIL32.@)
+ *             AVIStreamOpenFromFile   (AVIFILE.103)
  */
 HRESULT WINAPI AVIStreamOpenFromFileA(PAVISTREAM *ppavi, LPCSTR szFile,
                                      DWORD fccType, LONG lParam,
@@ -987,6 +990,7 @@ LONG WINAPI AVIStreamTimeToSample(PAVISTREAM pstream, LONG lTime)
 }
 
 /***********************************************************************
+ *             AVIBuildFilter          (AVIFIL32.@)
  *             AVIBuildFilterA         (AVIFIL32.@)
  *             AVIBuildFilter          (AVIFILE.123)
  */
index 208a239ed6fdd14d95ee2a7d6387fe1df36034cc..56308939a8be60c7422a6409bbbd836807b3348c 100644 (file)
@@ -168,6 +168,9 @@ static IClassFactoryVtbl ITSSCF_Vtbl =
 };
 
 
+/***********************************************************************
+ *             DllGetClassObject       (ITSS.@)
+ */
 HRESULT WINAPI DllGetClassObject(REFCLSID rclsid, REFIID iid, LPVOID *ppv)
 {
     DWORD i;
index 246ffec5fda725df4a741e7ccdbd581e71b3aa26..300e13ef5c60e2761debe71c72857a01cb1c3176 100644 (file)
@@ -1036,10 +1036,21 @@ HRESULT WINAPI ProgIDFromCLSID(REFCLSID clsid, LPOLESTR *lplpszProgID)
   return ret;
 }
 
-HRESULT WINAPI CLSIDFromProgID16(
-       LPCOLESTR16 progid,     /* [in] program id as found in registry */
-       LPCLSID riid            /* [out] associated CLSID */
-) {
+/******************************************************************************
+ *             CLSIDFromProgID [COMPOBJ.61]
+ *
+ * Converts a program ID into the respective GUID.
+ *
+ * PARAMS
+ *  progid       [I] program id as found in registry
+ *  riid         [O] associated CLSID
+ *
+ * RETURNS
+ *     Success: S_OK
+ *  Failure: CO_E_CLASSSTRING - the given ProgID cannot be found.
+ */
+HRESULT WINAPI CLSIDFromProgID16(LPCOLESTR16 progid, LPCLSID riid)
+{
        char    *buf,buf2[80];
        DWORD   buf2len;
        HRESULT err;
@@ -1063,7 +1074,6 @@ HRESULT WINAPI CLSIDFromProgID16(
 
 /******************************************************************************
  *             CLSIDFromProgID [OLE32.@]
- *             CLSIDFromProgID [COMPOBJ.61]
  *
  * Converts a program id into the respective GUID.
  *
index dc80440d06325dc8182f9c18c7d970761d47d185..89140b9ee2d078c1b21009170fe68d4421dfc22e 100644 (file)
 
 WINE_DEFAULT_DEBUG_CHANNEL(twain);
 
-/* Main entry point for the TWAIN library */
+/***********************************************************************
+ *             DSM_Entry (TWAIN.1)
+ *
+ * Main entry point for the TWAIN library
+ */
 TW_UINT16 WINAPI
 DSM_Entry16 (pTW_IDENTITY pOrigin,
            pTW_IDENTITY pDest,
index e12b0282a8b8f2d5134bd961f784cb0cfe345d7c..08bb674eeb09a98f5a4734b32937b177632a26e7 100644 (file)
@@ -731,7 +731,7 @@ UINT16 WINAPI midiOutGetDevCaps16(UINT16 uDeviceID, LPMIDIOUTCAPS16 lpCaps,
 
 /**************************************************************************
  *                             midiOutGetErrorText     [MMSYSTEM.203]
- *                             midiInGetErrorText      [MMSYSTEM.203]
+ *                             midiInGetErrorText      [MMSYSTEM.303]
  */
 UINT16 WINAPI midiOutGetErrorText16(UINT16 uError, LPSTR lpText, UINT16 uSize)
 {
@@ -1231,7 +1231,7 @@ UINT16 WINAPI waveOutGetDevCaps16(UINT16 uDeviceID,
 
 /**************************************************************************
  *                             waveOutGetErrorText     [MMSYSTEM.403]
- *                             waveInGetErrorText      [MMSYSTEM.403]
+ *                             waveInGetErrorText      [MMSYSTEM.503]
  */
 UINT16 WINAPI waveOutGetErrorText16(UINT16 uError, LPSTR lpText, UINT16 uSize)
 {