ReceiveTempSMS
/
Sweden-Number
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

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.
This commit is contained in:
Dimitrie O. Paun 2005-01-06 19:40:19 +00:00 committed by Alexandre Julliard
parent 01e2bdbf16
commit f783cd0305
1 changed files with 11 additions and 35 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

46
documentation/documentation.sgml
View File

@ -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.
*
@ -295,30 +295,6 @@
<command>[Out]</command>, <command>[I/O]</command>, <command>[In/Out]</command>.
</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
@ -364,7 +340,7 @@ BOOL WINAPI PathRelativePathToA(
<screen>
/*************************************************************************
* PathRelativePathToA [SHLWAPI.@]
* PathRelativePathToW [SHLWAPI.@]
*
* Create a relative path from one path to another.
*
@ -421,14 +397,14 @@ BOOL WINAPI PathRelativePathToA(
<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 @@ BOOL WINAPI PathRelativePathToA(
</para>
<screen>
/*************************************************************************
* PathRelativePathToW [SHLWAPI.@]
* PathRelativePathToA [SHLWAPI.@]
*
* Unicode version of PathRelativePathToA.
* Unicode version of PathRelativePathToW.
*/
</screen>