docs: update documentation instructions

[Dimitrie O. Paun]

ChangeLog
    Prefer W to A for documentation. Prefer the non-inlined
    style of documentation, it's the most commonly used one,
    we should standardize on it.


Index: documentation/documentation.sgml
===================================================================
RCS file: /var/cvs/wine/documentation/documentation.sgml,v
retrieving revision 1.16
diff -u -r1.16 documentation.sgml
--- documentation/documentation.sgml	26 Nov 2003 03:55:01 -0000	1.16
+++ documentation/documentation.sgml	6 Jan 2005 05:25:37 -0000
@@ -208,7 +208,7 @@
 
       <screen>
 /*************************************************************************
- * PathRelativePathToA   [SHLWAPI.@]
+ * PathRelativePathToW   [SHLWAPI.@]
  */
       </screen>
 
@@ -228,7 +228,7 @@
 
       <screen>
 /*************************************************************************
- *		PathRelativePathToA	(SHLWAPI.@)
+ *		PathRelativePathToW	(SHLWAPI.@)
  */
       </screen>
 
@@ -246,7 +246,7 @@
 
       <screen>
 /*************************************************************************
- * PathRelativePathToA   [SHLWAPI.@]
+ * PathRelativePathToW   [SHLWAPI.@]
  *
  * Create a relative path from one path to another.
  */
@@ -264,7 +264,7 @@
 
       <screen>
 /*************************************************************************
- * PathRelativePathToA   [SHLWAPI.@]
+ * PathRelativePathToW   [SHLWAPI.@]
  *
  * Create a relative path from one path to another.
  *
@@ -296,30 +296,6 @@
       </para>
 
       <para>
-        Parameters documented in the prototype should be formatted as follows:
-      </para>
-
-      <screen>
-/*************************************************************************
- * PathRelativePathToA   [SHLWAPI.@]
- *
- * Create a relative path from one path to another.
- *
- */
-BOOL WINAPI PathRelativePathToA(
- LPSTR  lpszPath,   /* [O] Destination for relative path */
- LPCSTR lpszFrom,   /* [I] Source path */
- DWORD  dwAttrFrom, /* [I] File attribute of source path */
- LPCSTR lpszTo,     /* [I] Destination path */
- DWORD  dwAttrTo)   /* [I] File attributes of destination path */
-      </screen>
-
-      <para>
-        The choice of which style to use is up to you, although for readability it
-        is suggested you stick with the same style within a single source file.
-      </para>
-
-      <para>
         Following the description and parameters come a number of optional sections, all
         in the same format. A section is defined as the section name, which is an all upper
         case section name on its own line, followed by free form text. You can create any
@@ -364,7 +340,7 @@
 
       <screen>
 /*************************************************************************
- * PathRelativePathToA   [SHLWAPI.@]
+ * PathRelativePathToW   [SHLWAPI.@]
  *
  * Create a relative path from one path to another.
  *
@@ -421,14 +397,14 @@
 
       <para>
         Where an Ascii and Unicode version of a function are available, it is
-        recommended that you document only the Ascii version and have the Unicode
-        version refer to the Ascii one, as follows:
+        recommended that you document only the Unicode version and have the Ascii
+        version refer to the Unicode one, as follows:
       </para>
       <screen>
 /*************************************************************************
- * PathRelativePathToW   [SHLWAPI.@]
+ * PathRelativePathToA   [SHLWAPI.@]
  *
- * See PathRelativePathToA.
+ * See PathRelativePathToW.
  */
       </screen>
       <para>
@@ -436,9 +412,9 @@
       </para>
       <screen>
 /*************************************************************************
- * PathRelativePathToW   [SHLWAPI.@]
+ * PathRelativePathToA   [SHLWAPI.@]
  *
- * Unicode version of PathRelativePathToA.
+ * Unicode version of PathRelativePathToW.
  */
       </screen>
 

-- 
Dimi.