VirtualBox

Changeset 58110 in vbox for trunk/include/VBox/com


Ignore:
Timestamp:
Oct 7, 2015 6:36:49 PM (9 years ago)
Author:
vboxsync
Message:

include,misc: Doxygen grouping adjustments, collecting all the VMM bits under one parent group, ditto for the COM library.

Location:
trunk/include/VBox/com
Files:
16 edited

Legend:

Unmodified
Added
Removed

  • trunk/include/VBox/com/AutoLock.h

    r58106 r58110  
    11/** @file
    2  * Automatic locks, implementation
     2 * MS COM / XPCOM Abstraction Layer - Automatic locks, implementation.
    33 */
    44
    … …  
    2828
    2929#include <iprt/types.h>
     30
     31
     32/** @defgroup grp_com_autolock  Automatic Locks
     33 * @ingroup grp_com
     34 * @{
     35 */
    3036
    3137// macros for automatic lock validation; these will amount to nothing
    … …  
    633639} /* namespace util */
    634640
     641/** @} */
     642
    635643#endif
    636644

  • trunk/include/VBox/com/ErrorInfo.h

    r58106 r58110  
    3131#include "VBox/com/Guid.h"
    3232#include "VBox/com/assert.h"
     33
     34
     35/** @defgroup grp_com_errinfo   ErrorInfo Classes
     36 * @ingroup grp_com
     37 * @{
     38 */
    3339
    3440COM_STRUCT_OR_CLASS(IProgress);
    … …  
    521527} /* namespace com */
    522528
     529/** @} */
     530
    523531#endif
    524532

  • trunk/include/VBox/com/EventQueue.h

    r56291 r58110  
    11/* $Id$ */
    22/** @file
    3  * Event queue class declaration.
     3 * MS COM / XPCOM Abstraction Layer - Event queue class declaration.
    44 */
    55
    … …  
    3535#include <VBox/com/defs.h>
    3636#include <VBox/com/assert.h>
     37
     38
     39/** @defgroup grp_com_evtqueue  Event Queue Classes
     40 * @ingroup grp_com
     41 * @{
     42 */
    3743
    3844namespace com
    … …  
    127133} /* namespace com */
    128134
     135/** @} */
     136
    129137#endif
    130138

  • trunk/include/VBox/com/Guid.h

    r56291 r58110  
    4141#include <iprt/err.h>
    4242
     43
     44/** @defgroup grp_com_guid  GUID Class
     45 * @ingroup grp_com
     46 * @{
     47 */
     48
    4349namespace com
    4450{
    … …  
    521527} /* namespace com */
    522528
     529/** @} */
     530
    523531#endif /* !___VBox_com_Guid_h */
    524532

  • trunk/include/VBox/com/MultiResult.h

    r58106 r58110  
    3232
    3333#include <stdarg.h>
     34
     35/** @defgroup grp_com_mr    MultiResult Classes
     36 * @ingroup grp_com
     37 * @{
     38 */
    3439
    3540namespace com
    … …  
    255260} /* namespace com */
    256261
     262/** @} */
     263
    257264#endif /* !___VBox_com_MultiResult_h */
    258265

  • trunk/include/VBox/com/NativeEventQueue.h

    r56291 r58110  
    11/** @file
    2  * MS COM / XPCOM Abstraction Layer:
    3  * Event and EventQueue class declaration
     2 * MS COM / XPCOM Abstraction Layer - Event and EventQueue class declaration.
    43 */
    54
    … …  
    3029#ifndef VBOX_WITH_XPCOM
    3130# include <Windows.h>
    32 #else // VBOX_WITH_XPCOM
     31#else
    3332# include <nsEventQueueUtils.h>
    34 #endif // VBOX_WITH_XPCOM
     33#endif
    3534
    3635#include <VBox/com/defs.h>
    3736#include <VBox/com/assert.h>
     37
     38
     39/** @defgroup grp_com_evt   Event and EventQueue Classes
     40 * @ingroup grp_com
     41 * @{
     42 */
    3843
    3944namespace com
    … …  
    138143} /* namespace com */
    139144
     145/** @} */
     146
    140147#endif
     148

  • trunk/include/VBox/com/array.h

    r58106 r58110  
    2727#define ___VBox_com_array_h
    2828
    29 /** @defgroup   grp_COM_arrays    COM/XPCOM Arrays
     29
     30/** @defgroup   grp_com_arrays    COM/XPCOM Arrays
     31 * @ingroup grp_com
    3032 * @{
    3133 *

  • trunk/include/VBox/com/assert.h

    r58099 r58110  
    2828
    2929#include <iprt/assert.h>
     30
     31/** @defgroup grp_com_assert    Assertion Macros for COM/XPCOM
     32 * @ingroup grp_com
     33 * @{
     34 */
     35
    3036
    3137/**
    … …  
    111117    do { if (SUCCEEDED(hrc)) { /*likely*/ } else { AssertComRCFailed(hrc); throw hrc; } } while (0)
    112118
     119/** @} */
     120
    113121#endif // !___VBox_com_assert_h
    114122

  • trunk/include/VBox/com/com.h

    r58106 r58110  
    2828
    2929#include "VBox/com/defs.h"
     30
     31/** @defgroup grp_com   MS COM / XPCOM Abstraction Layer
     32 * @{
     33 */
    3034
    3135namespace com
    … …  
    107111} /* namespace com */
    108112
     113/** @} */
    109114#endif
    110115

  • trunk/include/VBox/com/defs.h

    r58106 r58110  
    11/** @file
    2  * MS COM / XPCOM Abstraction Layer - Common definitions.
     2 * MS COM / XPCOM Abstraction Layer - Common Definitions.
    33 */
    44
    … …  
    6565 * we'll be without the macros that are optional in C++. */
    6666#include <iprt/types.h>
     67
     68
     69
     70/** @defgroup grp_com_defs  Common Definitions
     71 * @ingroup grp_com
     72 * @{
     73 */
    6774
    6875#if !defined(VBOX_WITH_XPCOM)
    … …  
    562569} /* namespace com */
    563570
     571/** @} */
     572
    564573#endif /* !___VBox_com_defs_h */
    565574

  • trunk/include/VBox/com/errorprint.h

    r58106 r58110  
    3333#include <VBox/com/ErrorInfo.h>
    3434
     35
     36/** @defgroup grp_com_error_reporting   Error Reporting
     37 * @ingroup grp_com
     38 * @{
     39 */
     40
    3541namespace com
    3642{
    … …  
    3945// compiled only once for all front-ends
    4046void GluePrintErrorInfo(const com::ErrorInfo &info);
    41 void GluePrintErrorContext(const char *pcszContext, const char *pcszSourceFile, uint32_t ulLine);
     47void GluePrintErrorContext(const char *pcszContext, const char *pcszSourceFile, uint32_t uLine);
    4248void GluePrintRCMessage(HRESULT rc);
    43 void GlueHandleComError(ComPtr<IUnknown> iface,
    44                         const char *pcszContext,
    45                         HRESULT rc,
    46                         const char *pcszSourceFile,
    47                         uint32_t ulLine);
    48 void GlueHandleComErrorProgress(ComPtr<IProgress> progress,
    49                                 const char *pcszContext,
    50                                 HRESULT rc,
    51                                 const char *pcszSourceFile,
    52                                 uint32_t ulLine);
     49void GlueHandleComError(ComPtr<IUnknown> iface, const char *pcszContext, HRESULT rc, const char *pcszSourceFile, uint32_t uLine);
     50void GlueHandleComErrorProgress(ComPtr<IProgress> progress, const char *pcszContext, HRESULT rc,
     51                                const char *pcszSourceFile, uint32_t uLine);
    5352
    5453/**
    … …  
    363362} /* namespace com */
    364363
     364/** @} */
     365
     366

  • trunk/include/VBox/com/list.h

    r58106 r58110  
    3333#include <iprt/cpp/list.h>
    3434
     35
     36/** @defgroup grp_com_list  List Classes
     37 * @ingroup grp_com
     38 * @{
     39 */
    3540
    3641/**
    … …  
    200205};
    201206
     207/** @} */
     208
    202209#endif /* !___VBox_com_list_h */
    203210

  • trunk/include/VBox/com/listeners.h

    r56291 r58110  
    11/* $Id$ */
    22/** @file
    3  * MS COM / XPCOM Abstraction Layer - Listeners helpers.
     3 * MS COM / XPCOM Abstraction Layer - Listener helpers.
    44 */
    55
    … …  
    3030#include <VBox/com/com.h>
    3131#include <VBox/com/VirtualBox.h>
     32
     33
     34/** @defgroup grp_com_listeners     Listener Helpers
     35 * @ingroup grp_com
     36 * @{
     37 */
     38
    3239
    3340#ifdef VBOX_WITH_XPCOM
    … …  
    169176#endif
    170177
     178/** @} */
    171179#endif
    172180

  • trunk/include/VBox/com/mtlist.h

    r58106 r58110  
    3232#include <VBox/com/array.h>
    3333#include <iprt/cpp/mtlist.h>
     34
     35
     36/** @defgroup grp_com_mtlist    Thread-safe List Classes
     37 * @ingroup grp_com
     38 * @{
     39 */
    3440
    3541/**
    … …  
    196202};
    197203
     204/** @} */
     205
    198206#endif /* !___VBox_com_mtlist_h */
    199207

  • trunk/include/VBox/com/ptr.h

    r56291 r58110  
    4646
    4747#include <VBox/com/defs.h>
     48
     49
     50/** @defgroup grp_com_ptr   Smart COM Pointer Classes
     51 * @ingroup grp_com
     52 * @{
     53 */
    4854
    4955#ifdef VBOX_WITH_XPCOM
    … …  
    499505    }
    500506};
     507
     508/** @} */
     509
    501510#endif
    502511

  • trunk/include/VBox/com/string.h

    r58106 r58110  
    4545#include <iprt/mem.h>
    4646#include <iprt/cpp/ministring.h>
     47
     48
     49/** @defgroup grp_com_str   Smart String Classes
     50 * @ingroup grp_com
     51 * @{
     52 */
    4753
    4854namespace com
    … …  
    816822} /* namespace com */
    817823
     824/** @} */
     825
    818826#endif /* !___VBox_com_string_h */
    819827
Note: See TracChangeset for help on using the changeset viewer.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette