Changeset 7170 in vbox for trunk/include/iprt/path.h

Timestamp:

Feb 27, 2008 1:20:01 PM (17 years ago)

Author:

vboxsync

Message:

Doxygen fixes. (DOXYGEN -> DOXYGEN_RUNNING, ++)

File:

• trunk/include/iprt/path.h (modified) (7 diffs)

trunk/include/iprt/path.h

@@ -92 +92 @@
  *          However it might be insufficient on other platforms
  *          and even on PC a UNC volume spec won't be detected this way.
- *          Use the RTPath<too be created>() instead.
+ *          Use the RTPath@<too be created@>() instead.
  *
  * @returns true if it is and false if it isn't.
@@ -116 +116 @@
 /**
  * Checks if the path exists.
- * 
+ *
  * Symbolic links will all be attempted resolved.
- * 
+ *
  * @returns true if it exists and false if it doesn't.
  * @param   pszPath     The path to check.
@@ -267 +267 @@
  * @param   pszPath2    Path to compare (must be an absolute path).
  *
- * @returns < 0 if the first path less than the second path.
+ * @returns @< 0 if the first path less than the second path.
  * @returns 0 if the first path identical to the second path.
- * @returns > 0 if the first path greater than the second path.
+ * @returns @> 0 if the first path greater than the second path.
  */
 RTDECL(int) RTPathCompare(const char *pszPath1, const char *pszPath2);
@@ -323 +323 @@
  *
  * Linux:    /usr/lib
- * Windows:  <program files directory>/<application>
+ * Windows:  @<program files directory@>/@<application@>
  * Old path: same as RTPathProgram()
  *
@@ -336 +336 @@
  * example NLS files, module sources, ...
  *
- * Linux:    /usr/shared/<application>
- * Windows:  <program files directory>/<application>
+ * Linux:    /usr/shared/@<application@>
+ * Windows:  @<program files directory@>/@<application@>
  * Old path: same as RTPathProgram()
  *
@@ -350 +350 @@
  * example modules which can be loaded at runtime.
  *
- * Linux:    /usr/lib/<application>
- * Windows:  <program files directory>/<application>
+ * Linux:    /usr/lib/@<application@>
+ * Windows:  @<program files directory@>/@<application@>
  * Old path: same as RTPathProgram()
  *
@@ -363 +363 @@
  * Gets the directory for documentation.
  *
- * Linux:    /usr/share/doc/<application>
- * Windows:  <program files directory>/<application>
+ * Linux:    /usr/share/doc/@<application@>
+ * Windows:  @<program files directory@>/@<application@>
  * Old path: same as RTPathProgram()
  *