Changeset 51321 in vbox for trunk

Timestamp:

May 21, 2014 1:02:44 PM (11 years ago)

Author:

vboxsync

Message:

Main: Fixed broken documentation due to wrapper changes.

Location:

trunk/src/VBox/Main/include

Files:

• GuestDirectoryImpl.h (modified) (2 diffs)
• GuestFileImpl.h (modified) (6 diffs)
• GuestFsObjInfoImpl.h (modified) (4 diffs)
• GuestProcessImpl.h (modified) (3 diffs)
• GuestSessionImpl.h (modified) (4 diffs)

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

@@ -1 @@
-
 /* $Id$ */
 /** @file
- * VirtualBox Main - XXX.
+ * VirtualBox Main - Guest directory handling implementation.
  */
 
 /*
- * Copyright (C) 2012 Oracle Corporation
+ * Copyright (C) 2012-2014 Oracle Corporation
  *
  * This file is part of VirtualBox Open Source Edition (OSE), as
@@ -44 +43 @@
     /** @}  */
 
-
 public:
     /** @name Public internal methods.

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

@@ -1 @@
-
 /* $Id$ */
 /** @file
- * VirtualBox Main - Guest file handling.
+ * VirtualBox Main - Guest file handling implementation.
  */
 
@@ -30 +29 @@
 class GuestProcess;
 
-/**
- * TODO
- */
 class ATL_NO_VTABLE GuestFile :
     public GuestFileWrap,
@@ -48 +44 @@
     void    FinalRelease(void);
     /** @}  */
-
 
 public:
@@ -77 +72 @@
 private:
 
-    // Wrapped IGuestFile properties.
+    /** Wrapped @name IGuestFile properties.
+     * @{ */
     HRESULT getCreationMode(ULONG *aCreationMode);
     HRESULT getDisposition(com::Utf8Str &aDisposition);
@@ -87 +83 @@
     HRESULT getOffset(LONG64 *aOffset);
     HRESULT getStatus(FileStatus_T *aStatus);
+    /** @}  */
 
-    // Wrapped IGuestFile methods.
+    /** Wrapped @name IGuestFile methods.
+     * @{ */
     HRESULT close();
     HRESULT queryInfo(ComPtr<IFsObjInfo> &aObjInfo);
@@ -108 +106 @@
                     ULONG aTimeoutMS,
                     ULONG *aWritten);
+    /** @}  */
 
     /** This can safely be used without holding any locks.

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

@@ -1 @@
-
 /* $Id$ */
 /** @file
- * VirtualBox Main - XXX.
+ * VirtualBox Main - Guest file system object information implementation.
  */
 
@@ -23 +22 @@
 #include "GuestCtrlImplPrivate.h"
 
-/**
- * TODO
- */
 class ATL_NO_VTABLE GuestFsObjInfo :
     public GuestFsObjInfoWrap
@@ -39 +35 @@
     HRESULT FinalConstruct(void);
     void    FinalRelease(void);
+    /** @}  */
 
 private:
 
-    // Wrapped GuestFsObjInfo properties.
+    /** Wrapped @name IGuestFsObjInfo properties.
+     * @{ */
     HRESULT getAccessTime(LONG64 *aAccessTime);
     HRESULT getAllocatedSize(LONG64 *aAllocatedSize);
@@ -62 +60 @@
     HRESULT getUserFlags(ULONG *aUserFlags);
     HRESULT getUserName(com::Utf8Str &aUserName);
+    /** @}  */
 
     GuestFsObjData mData;

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

@@ -1 @@
-
 /* $Id$ */
 /** @file
- * VirtualBox Main - Guest process handling.
+ * VirtualBox Main - Guest process handling implementation.
  */
 
 /*
- * Copyright (C) 2012-2013 Oracle Corporation
+ * Copyright (C) 2012-2014 Oracle Corporation
  *
  * This file is part of VirtualBox Open Source Edition (OSE), as
@@ -43 +42 @@
     void    FinalRelease(void);
     /** @}  */
-
 
 public:
@@ -91 +89 @@
 
 private:
-    /** Wrapped @name IProcess data .
-     * @{ */
-     HRESULT getArguments(std::vector<com::Utf8Str> &aArguments);
-     HRESULT getEnvironment(std::vector<com::Utf8Str> &aEnvironment);
-     HRESULT getEventSource(ComPtr<IEventSource> &aEventSource);
-     HRESULT getExecutablePath(com::Utf8Str &aExecutablePath);
-     HRESULT getExitCode(LONG *aExitCode);
-     HRESULT getName(com::Utf8Str &aName);
-     HRESULT getPID(ULONG *aPID);
-     HRESULT getStatus(ProcessStatus_T *aStatus);
+    /** Wrapped @name IProcess properties.
+     * @{ */
+    HRESULT getArguments(std::vector<com::Utf8Str> &aArguments);
+    HRESULT getEnvironment(std::vector<com::Utf8Str> &aEnvironment);
+    HRESULT getEventSource(ComPtr<IEventSource> &aEventSource);
+    HRESULT getExecutablePath(com::Utf8Str &aExecutablePath);
+    HRESULT getExitCode(LONG *aExitCode);
+    HRESULT getName(com::Utf8Str &aName);
+    HRESULT getPID(ULONG *aPID);
+    HRESULT getStatus(ProcessStatus_T *aStatus);
+    /** @}  */
 
     /** Wrapped @name IProcess methods.
      * @{ */
-     HRESULT waitFor(ULONG aWaitFor,
-                     ULONG aTimeoutMS,
-                     ProcessWaitResult_T *aReason);
-     HRESULT waitForArray(const std::vector<ProcessWaitForFlag_T> &aWaitFor,
-                          ULONG aTimeoutMS,
-                          ProcessWaitResult_T *aReason);
-     HRESULT read(ULONG aHandle,
-                  ULONG aToRead,
+    HRESULT waitFor(ULONG aWaitFor,
+                    ULONG aTimeoutMS,
+                    ProcessWaitResult_T *aReason);
+    HRESULT waitForArray(const std::vector<ProcessWaitForFlag_T> &aWaitFor,
+                         ULONG aTimeoutMS,
+                         ProcessWaitResult_T *aReason);
+    HRESULT read(ULONG aHandle,
+                 ULONG aToRead,
+                 ULONG aTimeoutMS,
+                 std::vector<BYTE> &aData);
+    HRESULT write(ULONG aHandle,
+                  ULONG aFlags,
+                  const std::vector<BYTE> &aData,
                   ULONG aTimeoutMS,
-                  std::vector<BYTE> &aData);
-     HRESULT write(ULONG aHandle,
-                   ULONG aFlags,
-                   const std::vector<BYTE> &aData,
-                   ULONG aTimeoutMS,
-                   ULONG *aWritten);
-     HRESULT writeArray(ULONG aHandle,
-                        const std::vector<ProcessInputFlag_T> &aFlags,
-                        const std::vector<BYTE> &aData,
-                        ULONG aTimeoutMS,
-                        ULONG *aWritten);
-     HRESULT terminate();
+                  ULONG *aWritten);
+    HRESULT writeArray(ULONG aHandle,
+                       const std::vector<ProcessInputFlag_T> &aFlags,
+                       const std::vector<BYTE> &aData,
+                       ULONG aTimeoutMS,
+                       ULONG *aWritten);
+    HRESULT terminate(void);
+    /** @}  */
 
     /**

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

@@ -1 @@
-
 /* $Id$ */
 /** @file
@@ -259 +258 @@
 private:
 
-    // Wrapped GuestSession Properties
+    /** Wrapped @name IGuestSession properties.
+     * @{ */
     HRESULT getUser(com::Utf8Str &aUser);
     HRESULT getDomain(com::Utf8Str &aDomain);
@@ -274 +274 @@
     HRESULT getFiles(std::vector<ComPtr<IGuestFile> > &aFiles);
     HRESULT getEventSource(ComPtr<IEventSource> &aEventSource);
-
-    // Wrapped GuestSession Methods
+    /** @}  */
+
+    /** Wrapped @name IGuestSession methods.
+     * @{ */
     HRESULT close();
     HRESULT copyFrom(const com::Utf8Str &aSource,
@@ -377 +379 @@
                          ULONG aTimeoutMS,
                          GuestSessionWaitResult_T *aReason);
-
+    /** @}  */
 
     /** Map of guest directories. The key specifies the internal directory ID. */