ceph/src/Beast/extras/beast/doc_debug.hpp

   1 //
   2 // Copyright (c) 2013-2017 Vinnie Falco (vinnie dot falco at gmail dot com)
   3 //
   4 // Distributed under the Boost Software License, Version 1.0. (See accompanying
   5 // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
   6 //
   7
   8 #ifndef BEAST_DOC_DEBUG_HPP
   9 #define BEAST_DOC_DEBUG_HPP
  10
  11 namespace beast {
  12
  13 #if BEAST_DOXYGEN
  14
  15 /// doc type (documentation debug helper)
  16 using doc_type = int;
  17
  18 /// doc enum (documentation debug helper)
  19 enum doc_enum
  20 {
  21     /// One (documentation debug helper)
  22     one,
  23
  24     /// Two (documentation debug helper)
  25     two
  26 };
  27
  28 /// doc enum class (documentation debug helper)
  29 enum class doc_enum_class : unsigned
  30 {
  31     /// one (documentation debug helper)
  32     one,
  33
  34     /// two (documentation debug helper)
  35     two
  36 };
  37
  38 /// doc func (documentation debug helper)
  39 void doc_func();
  40
  41 /// doc class (documentation debug helper)
  42 struct doc_class
  43 {
  44     /// doc class member func (documentation debug helper)
  45     void func();
  46 };
  47
  48 /// (documentation debug helper)
  49 namespace nested {
  50
  51 /// doc type (documentation debug helper)
  52 using nested_doc_type = int;
  53
  54 /// doc enum (documentation debug helper)
  55 enum nested_doc_enum
  56 {
  57     /// One (documentation debug helper)
  58     one,
  59
  60     /// Two (documentation debug helper)
  61     two
  62 };
  63
  64 /// doc enum class (documentation debug helper)
  65 enum class nested_doc_enum_class : unsigned
  66 {
  67     /// one (documentation debug helper)
  68     one,
  69
  70     /// two (documentation debug helper)
  71     two
  72 };
  73
  74 /// doc func (documentation debug helper)
  75 void nested_doc_func();
  76
  77 /// doc class (documentation debug helper)
  78 struct nested_doc_class
  79 {
  80     /// doc class member func (documentation debug helper)
  81     void func();
  82 };
  83
  84 } // nested
  85
  86 /** This is here to help troubleshoot doc/reference.xsl problems
  87
  88     Embedded references:
  89
  90     @li type @ref doc_type
  91
  92     @li enum @ref doc_enum
  93
  94     @li enum item @ref doc_enum::one
  95
  96     @li enum_class @ref doc_enum_class
  97
  98     @li enum_class item @ref doc_enum_class::one
  99
 100     @li func @ref doc_func
 101
 102     @li class @ref doc_class
 103
 104     @li class func @ref doc_class::func
 105
 106     @li nested type @ref nested::nested_doc_type
 107
 108     @li nested enum @ref nested::nested_doc_enum
 109
 110     @li nested enum item @ref nested::nested_doc_enum::one
 111
 112     @li nested enum_class @ref nested::nested_doc_enum_class
 113
 114     @li nested enum_class item @ref nested::nested_doc_enum_class::one
 115
 116     @li nested func @ref nested::nested_doc_func
 117
 118     @li nested class @ref nested::nested_doc_class
 119
 120     @li nested class func @ref nested::nested_doc_class::func
 121 */
 122 void doc_debug();
 123
 124 namespace nested {
 125
 126 /** This is here to help troubleshoot doc/reference.xsl problems
 127
 128     Embedded references:
 129
 130     @li type @ref doc_type
 131
 132     @li enum @ref doc_enum
 133
 134     @li enum item @ref doc_enum::one
 135
 136     @li enum_class @ref doc_enum_class
 137
 138     @li enum_class item @ref doc_enum_class::one
 139
 140     @li func @ref doc_func
 141
 142     @li class @ref doc_class
 143
 144     @li class func @ref doc_class::func
 145
 146     @li nested type @ref nested_doc_type
 147
 148     @li nested enum @ref nested_doc_enum
 149
 150     @li nested enum item @ref nested_doc_enum::one
 151
 152     @li nested enum_class @ref nested_doc_enum_class
 153
 154     @li nested enum_class item @ref nested_doc_enum_class::one
 155
 156     @li nested func @ref nested_doc_func
 157
 158     @li nested class @ref nested_doc_class
 159
 160     @li nested class func @ref nested_doc_class::func
 161 */
 162 void nested_doc_debug();
 163
 164 } // nested
 165
 166 #endif
 167
 168 } // beast
 169
 170 #endif