Changeset 71281 in vbox for trunk/src/VBox/Main/include

Timestamp:

Mar 9, 2018 9:24:01 AM (7 years ago)

Author:

vboxsync

Message:

Guest Control/GuestProcessImpl.h: Docs.

File:

• trunk/src/VBox/Main/include/GuestProcessImpl.h (modified) (4 diffs)

trunk/src/VBox/Main/include/GuestProcessImpl.h

@@ -5 +5 @@
 
 /*
- * Copyright (C) 2012-2017 Oracle Corporation
+ * Copyright (C) 2012-2018 Oracle Corporation
  *
  * This file is part of VirtualBox Open Source Edition (OSE), as
@@ -223 +223 @@
     GuestProcessStream &getStdErr(void) { return mStdErr; }
 
-    int wait(uint32_t fFlags, int *pGuestRc);
-
-    int waitEx(uint32_t fFlags, GuestProcessStreamBlock *pStreamBlock, int *pGuestRc);
+    int wait(uint32_t fToolWaitFlags, int *pGuestRc);
+
+    int waitEx(uint32_t fToolWaitFlags, GuestProcessStreamBlock *pStreamBlock, int *pGuestRc);
 
     bool isRunning(void);
@@ -235 +235 @@
 public:
 
+    /** Wrapped @name Static run methods.
+     * @{ */
     static int run(GuestSession *pGuestSession, const GuestProcessStartupInfo &startupInfo, int *pGuestRc);
 
@@ -244 +246 @@
     static int runExErrorInfo(GuestSession *pGuestSession, const GuestProcessStartupInfo &startupInfo,
                               GuestCtrlStreamObjects *pStrmOutObjects, uint32_t cStrmOutObjects, GuestProcessToolErrorInfo &errorInfo);
-
+    /** @}  */
+
+    /** Wrapped @name Static exit code conversion methods.
+     * @{ */
     static int exitCodeToRc(const GuestProcessStartupInfo &startupInfo, int32_t iExitCode);
 
     static int exitCodeToRc(const char *pszTool, int32_t iExitCode);
+    /** @}  */
 
 protected:
 
+    /** Pointer to session this toolbox object is bound to. */
     ComObjPtr<GuestSession>     pSession;
+    /** Pointer to process object this toolbox object is bound to. */
     ComObjPtr<GuestProcess>     pProcess;
+    /** The toolbox' startup info. */
     GuestProcessStartupInfo     mStartupInfo;
+    /** Stream object for handling the toolbox' stdout data. */
     GuestProcessStream          mStdOut;
+    /** Stream object for handling the toolbox' stderr data. */
     GuestProcessStream          mStdErr;
 };