Changeset 31397 in vbox for trunk

Timestamp:

Aug 5, 2010 12:16:10 PM (14 years ago)

Author:

vboxsync

Message:

iprt/getopt.h: docs.

File:

• trunk/include/iprt/getopt.h (modified) (4 diffs)

trunk/include/iprt/getopt.h

@@ -38 +38 @@
  */
 
-/** @name RTGETOPTDEF::fFlags
+/** @name Values for RTGETOPTDEF::fFlags and the fFlags parameter of
+ *        RTGetOptFetchValue.
  *
  * @remarks When neither of the RTGETOPT_FLAG_HEX, RTGETOPT_FLAG_OCT and RTGETOPT_FLAG_DEC
@@ -262 +263 @@
 int main(int argc, char **argv)
 {
-     RTR3Init();
+     int rc = RTR3Init();
+     if (RT_FAILURE(rc))
+         return RTMsgInitFailure(rc);
 
      static const RTGETOPTDEF s_aOptions[] =
@@ -301 +304 @@
      }
 
-     return 0;
+     return RTEXITCODE_SUCCESS;
 }
    @endcode
@@ -347 +350 @@
  *                      that require an argument, this contains the value of
  *                      that argument, depending on the type that is required.
- * @param   fFlags      The flags.
+ * @param   fFlags      What to get, that is RTGETOPT_REQ_XXX.
  */
 RTDECL(int) RTGetOptFetchValue(PRTGETOPTSTATE pState, PRTGETOPTUNION pValueUnion, uint32_t fFlags);