src/doxygen/group_definitions.hh

   1 /**
   2  * @defgroup api_drain The Drain API.
   3  *
   4  * These methods relate to the "Drainable" interface.
   5  */
   6
   7 /**
   8  * @defgroup api_serialize The Serialize API.
   9  *
  10  * These methods related to the "Serialize" interface.
  11  */
  12
  13 /**
  14  * @defgroup api_eventq The Event Queue API.
  15  *
  16  * These methods relate to the event queue interface.
  17  */
  18
  19 /**
  20  * @defgroup api_stats The Stats API.
  21  *
  22  * These methods relate to the statistics I/O interface.
  23  */
  24
  25 /**
  26  * @defgroup api_simobject The SimObject API.
  27  *
  28  * These methods relate to the SimObject interface.
  29  */
  30
  31 /**
  32  * @defgroup api_addr_range The AddrRange API.
  33  *
  34  * These methods relate to the AddrRange and AddrRangeMap interfaces.
  35  */
  36
  37 /**
  38  * @defgroup api_atomic_op The AtomicOpFunctor API.
  39  *
  40  * These methods relate to the AtomicOpFunctor and the related interfaces.
  41  */
  42
  43 /**
  44  * @defgroup api_bitfield The bit manipulating API.
  45  *
  46  * These are a collection of methods for bit manipulations.
  47  */
  48
  49 /**
  50  * @defgroup api_bitunion The BitUnion API.
  51  *
  52  * These are a collection of methods and macros of the BitUnion system of
  53  * defining bitfields on top of an underlying class.
  54  */
  55
  56 /**
  57  * @defgroup api_base_utils The utility functions and constants API.
  58  *
  59  * These are a collection of utility functions and constants defined in
  60  * src/base.
  61  */
  62
  63 /**
  64  * @defgroup api_callback The CallbackQueue API.
  65  *
  66  * These methods relate to the CallbackQueue interface.
  67  */
  68
  69 /**
  70  * @defgroup api_channel_addr The ChannelAddr and ChannelAddrRange API.
  71  *
  72  * These methods relate to the interface of ChannelAddr and ChannelAddrRange.
  73  */
  74
  75 /**
  76  * @defgroup api_chunk_generator The ChunkGenerator API.
  77  *
  78  * These methods relate to the ChunkGenerator interface.
  79  */
  80
  81 /**
  82  * @defgroup api_coroutine The Coroutine API.
  83  *
  84  * These methods relate to the Coroutine interface.
  85  */
  86
  87 /**
  88  * @defgroup api_fiber The Fiber API.
  89  *
  90  * These methods relate to the Fiber interface.
  91  */
  92
  93 /**
  94  * @defgroup api_flags The Flags API.
  95  *
  96  * These methods relate to the Flags interface.
  97  */
  98
  99 /**
 100  * @defgroup api_inet The inet API.
 101  *
 102  * These methods relate to EthAddr, IpAddress, TCP, UDP interfaces.
 103  */
 104
 105 /**
 106  * @defgroup api_logger The Logger API.
 107  *
 108  * These methods and macros provide access to gem5's logging system.
 109  */
 110
 111 /**
 112  * @defgroup api_poll_event The PollEvent API.
 113  *
 114  * These methods relate to the PollEvent interface.
 115  */
 116
 117 /**
 118  * @defgroup api_poll_queue The PollQueue API.
 119  *
 120  * These methods relate to the PollQueue interface.
 121  */
 122
 123 /**
 124  * @defgroup api_remote_gdb The RemoteGDB API.
 125  *
 126  * These methods relate to the BaseRemoteGDB and BaseGdbRegCache interfaces.
 127  */
 128
 129 /**
 130  * @defgroup api_sat_counter The SatCounter API.
 131  *
 132  * These methods relate to the SatCounter interface.
 133  */
 134
 135 /**
 136  * @defgroup api_socket The Socket API.
 137  *
 138  * These methods relate to the Socket interface.
 139  */
 140
 141 /**
 142  * @defgroup api_stl_helpers The C++ STL helpers API.
 143  *
 144  * These are methods providing additional functionality to C++ STL.
 145  */
 146
 147 /**
 148  * @defgroup api_trace The Trace API.
 149  *
 150  * These methods relate to the selective debugging trace facility.
 151  */