ceph/src/boost/libs/geometry/doc/doxy/Doxyfile

   1 # Doxyfile 1.5.5
   2
   3 #---------------------------------------------------------------------------
   4 # Project related configuration options
   5 #---------------------------------------------------------------------------
   6 DOXYFILE_ENCODING      = UTF-8
   7 PROJECT_NAME           = "Boost.Geometry (aka GGL)"
   8 PROJECT_NUMBER         =
   9 OUTPUT_DIRECTORY       = ./doxygen_output
  10 CREATE_SUBDIRS         = NO
  11 OUTPUT_LANGUAGE        = English
  12 BRIEF_MEMBER_DESC      = YES
  13 REPEAT_BRIEF           = YES
  14 ABBREVIATE_BRIEF       =
  15 ALWAYS_DETAILED_SEC    = YES
  16 INLINE_INHERITED_MEMB  = NO
  17 FULL_PATH_NAMES        = YES
  18 STRIP_FROM_PATH        = c:/_svn/boost/trunk/boost/geometry  \
  19                          c:/_svn/boost/trunk/libs/geometry/doc/doxygen_input/pages
  20 STRIP_FROM_INC_PATH    =
  21 SHORT_NAMES            = NO
  22 JAVADOC_AUTOBRIEF      = NO
  23 QT_AUTOBRIEF           = NO
  24 MULTILINE_CPP_IS_BRIEF = NO
  25 INHERIT_DOCS           = YES
  26 SEPARATE_MEMBER_PAGES  = NO
  27 TAB_SIZE               = 8
  28
  29 # The aliases are shortcuts for Doxygen documentation.
  30 # Within Boost.Geometry they are used in the top section, so for both
  31 # Doxygen documentation and QuickBook documentation.
  32 # They avoid repetations and make the documentation more structured.
  33 # There are also qbk expressions, which might qbk defines and templates.
  34
  35 # There are sections for
  36 # \brief* for various brief descriptions
  37 # \tparam* for various template parameters
  38 # \param* for various parameters
  39 # \return* for various return cases
  40 ALIASES                = qbk{1}="\xmlonly <qbk>\1</qbk> \endxmlonly" \
  41                          qbk{2}="\xmlonly <qbk.\1>\2</qbk.\1> \endxmlonly" \
  42                          brief_calc{1}="Calculates the \1 of a geometry" \
  43                          brief_calc2{1}="Calculate the \1 of two geometries" \
  44                          brief_calc2{2}="Calculate the \1 \2 two geometries" \
  45                          brief_check{1}="Checks if a geometry \1" \
  46                          brief_check2{1}="Checks if two geometries \1" \
  47                          brief_check12{1}="Checks if the first geometry \1 the second geometry" \
  48                          brief_strategy="using the specified strategy" \
  49                          brief_macro{1}="Macro to register a \1" \
  50                          brief_macro_const=" (const version)" \
  51                          brief_macro_getset=" (having separate get/set methods)" \
  52                          brief_meta{3}="Metafunction defining [*\1] as the \2 of the \3" \
  53                          tparam_allocator="container-allocator-type" \
  54                          tparam_box="Any type fulfilling a Box Concept" \
  55                          tparam_box_or_segment="Any type fulfilling a Box Concept or a Segment Concept" \
  56                          tparam_calculation="numeric type for calculation (e.g. high precision); if [*void] then it is extracted automatically from the coordinate type and (if necessary) promoted to floating point" \
  57                          tparam_radius="numeric type for radius (of sphere, earth)" \
  58                          tparam_container="container type, for example std::vector, std::deque" \
  59                          tparam_dimension_required="Dimension, this template parameter is required. Should contain \\[0 .. n-1\\] for an n-dimensional geometry" \
  60                          tparam_functor="Function or class with operator()" \
  61                          tparam_output_collection="output collection, either a multi-geometry, or a std::vector<Geometry> / std::deque<Geometry> etc" \
  62                          tparam_geometry="Any type fulfilling a Geometry Concept" \
  63                          tparam_geometry{1}="A type fulfilling the \1 Concept" \
  64                          tparam_index_required="Index, this template parameter is required. For a Box: either min_corner or max_corner. For a Segment: either 0 or 1 for first or last point." \
  65                          tparam_numeric="numerical type (int, double, ttmath, ...)" \
  66                          tparam_out{1}="A valid output iterator type, accepting geometries of \1 Concept" \
  67                          tparam_point="Any type fulfilling a Point Concept" \
  68                          tparam_range_point="Any type fulfilling a Range Concept where it range_value type fulfills the Point Concept" \
  69                          tparam_first_point="first point type" \
  70                          tparam_first_box="first box type" \
  71                          tparam_second_point="second point type" \
  72                          tparam_second_box="second box type" \
  73                          tparam_segment_point="segment point type" \
  74                          tparam_strategy{1}="Any type fulfilling a \1 Strategy Concept" \
  75                          tparam_strategy_overlay="Compound strategy for segment intersection" \
  76                          param_box="A model of the specified Box Concept" \
  77                          param_box_or_segment="A box modelling the specified Box Concept or segment modelling the specified Segment Concept" \
  78                          param_geometry="A model of the specified concept" \
  79                          param_out{1}="The output iterator, to which \1 geometries are feeded" \
  80                          param_point="A model of the specified Point Concept" \
  81                          param_set{1}="which is set to the \1" \
  82                          param_strategy{1}="The strategy which will be used for \1 calculations" \
  83                          param_macro_type{1}="\1 type to be registered" \
  84                          param_macro_coortype{1}="Type of the coordinates of the \1 (e.g. double)" \
  85                          param_macro_coorsystem="Coordinate system (e.g. cs::cartesian)" \
  86                          param_macro_member{1}="Member containing \1 coordinate" \
  87                          param_macro_getset{2}="Method to \1 the \2 coordinate" \
  88                          param_range_point="A range containg points fulfilling range and point concepts" \
  89                          param_x="First coordinate (usually x-coordinate)" \
  90                          param_y="Second coordinate (usually y-coordinate)" \
  91                          param_z="Third coordinate (usually z-coordinate)" \
  92                          constructor_default_no_init="Default constructor, no initialization" \
  93                          constructor_default{1}="Default constructor, creating an empty \1" \
  94                          constructor_begin_end{1}="Constructor with begin and end,  filling the \1" \
  95                          constructor_initializer_list{1}="Constructor taking std::initializer_list, filling the \1" \
  96                          assignment_initializer_list{1}="Assignment operator taking std::initializer_list, assigning values to the \1" \
  97                          details_calc{2}="The free function \1 calculates the \2 of a geometry" \
  98                          details_calc{1}="The free function \1 calculates the \1 of a geometry" \
  99                          details_calc2{2}="The free function \1 calculates the \2 of two geometries" \
 100                          details_calc2{1}="The free function \1 calculates the \1 of two geometries" \
 101                          details_check12{2}="The free function \1 checks if the first geometry \2 the second geometry" \
 102                          details_macro{2}="The macro \1 registers a \2 such that it is recognized by Boost.Geometry and that Boost.Geometry functionality can used with the specified type." \
 103                          details_macro_const="The const version registers only read access to the fields, the point type is therefore read-only" \
 104                          details_macro_getset="The get/set version registers get and set methods separately and can be used for classes with protected member variables and get/set methods to change coordinates" \
 105                          details_macro_templated{2}="The type must have one template parameter, which should be a \2 type, and should not be specified. Boost.Geometry takes care of inserting the template parameter. Hence all types of this templated \1 are registered, regardless of their point type." \
 106                          details_default_strategy="It uses the default strategy, based on the coordinate system of the geometry." \
 107                          details_strategy_reasons="Reasons to specify a strategy include: use another coordinate system for calculations; construct the strategy beforehand (e.g. with the radius of the Earth); select a strategy when there are more than one available for a calculation." \
 108                          details_return{1}="This version with the return_ prefix returns the \1, and a template parameter must therefore be specified in the call." \
 109                          details_insert{1}="This version with the _insert suffix outputs the \1 to an output iterator, and a template parameter must therefore be specified in the call." \
 110                          details_get_set="The free functions [*get] and [*set] are two of the most important functions of Boost.Geometry, both within the library, as also for the library user. With these two functions you normally get and set coordinate values from and for a point, box, segment or sphere." \
 111                          details_make="Boost.Geometry uses concepts for all its geometries. It does not rely on constructors. The "make" functions are object generators creating geometries. There are overloads, currently with two or three coordinate values or ranges, to construct geometry instances" \
 112                          return_calc{1}="The calculated \1" \
 113                          return_check{1}="Returns true if the geometry \1" \
 114                          return_check2{1}="Returns true if two geometries \1" \
 115                          return_out="The output iterator" \
 116                          meta_geometry_type="specified geometry type" \
 117                          meta_point_type="point type making up the specified geometry type" \
 118                          brf_for_each{1}="Applies function [*f] to each \1" \
 119                          det_envelope="envelope (also known as axis aligned bounding box, aabb, or minimum bounding rectangle, mbr)" \
 120                          det_buffer="buffer (a polygon being the spatial point set collection within a specified maximum distance from a geometry)" \
 121                          det_for_each{1}="Applies a function [*f] (functor, having operator() defined) to each \1 making up the geometry" \
 122                          par_for_each_f{1}="Unary function, taking a \1 as argument" \
 123                          macro_x="first (usually x)" \
 124                          macro_y="second (usually y)" \
 125                          macro_z="third (usually z)" \
 126                          p_l_or_c="Point, LineString or Polygon"
 127 OPTIMIZE_OUTPUT_FOR_C  = NO
 128 OPTIMIZE_OUTPUT_JAVA   = NO
 129 OPTIMIZE_FOR_FORTRAN   = NO
 130 OPTIMIZE_OUTPUT_VHDL   = NO
 131 BUILTIN_STL_SUPPORT    = YES
 132 CPP_CLI_SUPPORT        = NO
 133 SIP_SUPPORT            = NO
 134 DISTRIBUTE_GROUP_DOC   = NO
 135 SUBGROUPING            = YES
 136 TYPEDEF_HIDES_STRUCT   = NO
 137 #---------------------------------------------------------------------------
 138 # Build related configuration options
 139 #---------------------------------------------------------------------------
 140 EXTRACT_ALL            = YES
 141 EXTRACT_PRIVATE        = NO
 142 EXTRACT_STATIC         = YES
 143 EXTRACT_LOCAL_CLASSES  = NO
 144 EXTRACT_LOCAL_METHODS  = NO
 145 EXTRACT_ANON_NSPACES   = NO
 146 HIDE_UNDOC_MEMBERS     = NO
 147 HIDE_UNDOC_CLASSES     = NO
 148 HIDE_FRIEND_COMPOUNDS  = NO
 149 HIDE_IN_BODY_DOCS      = NO
 150 INTERNAL_DOCS          = NO
 151 CASE_SENSE_NAMES       = NO
 152 HIDE_SCOPE_NAMES       = NO
 153 SHOW_INCLUDE_FILES     = NO
 154 INLINE_INFO            = NO
 155 SORT_MEMBER_DOCS       = NO
 156 SORT_BRIEF_DOCS        = YES
 157 SORT_GROUP_NAMES       = YES
 158 SORT_BY_SCOPE_NAME     = YES
 159 GENERATE_TODOLIST      = NO
 160 GENERATE_TESTLIST      = YES
 161 GENERATE_BUGLIST       = YES
 162 GENERATE_DEPRECATEDLIST= YES
 163 ENABLED_SECTIONS       =
 164 MAX_INITIALIZER_LINES  = 30
 165 SHOW_USED_FILES        = NO
 166 FILE_VERSION_FILTER    =
 167 #---------------------------------------------------------------------------
 168 # configuration options related to warning and progress messages
 169 #---------------------------------------------------------------------------
 170 QUIET                  = YES
 171 WARNINGS               = YES
 172 WARN_IF_UNDOCUMENTED   = YES
 173 WARN_IF_DOC_ERROR      = YES
 174 WARN_NO_PARAMDOC       = NO
 175 WARN_FORMAT            = "$file:$line: $text"
 176 WARN_LOGFILE           =
 177 #---------------------------------------------------------------------------
 178 # configuration options related to the input files
 179 #---------------------------------------------------------------------------
 180 INPUT                  = . .. ../../../../boost/geometry/core \
 181                          ../../../../boost/geometry/algorithms \
 182                          ../../../../boost/geometry/algorithms/detail \
 183                          ../../../../boost/geometry/algorithms/detail/buffer \
 184                          ../../../../boost/geometry/algorithms/detail/comparable_distance \
 185                          ../../../../boost/geometry/algorithms/detail/disjoint \
 186                          ../../../../boost/geometry/algorithms/detail/distance \
 187                          ../../../../boost/geometry/algorithms/detail/envelope \
 188                          ../../../../boost/geometry/algorithms/detail/equals \
 189                          ../../../../boost/geometry/algorithms/detail/expand \
 190                          ../../../../boost/geometry/algorithms/detail/intersection \
 191                          ../../../../boost/geometry/algorithms/detail/is_simple \
 192                          ../../../../boost/geometry/algorithms/detail/is_valid \
 193                          ../../../../boost/geometry/algorithms/detail/overlay \
 194                          ../../../../boost/geometry/algorithms/detail/relate \
 195                          ../../../../boost/geometry/algorithms/detail/relation \
 196                          ../../../../boost/geometry/algorithms/detail/sections \
 197                          ../../../../boost/geometry/algorithms/detail/turns \
 198                          ../../../../boost/geometry/algorithms/detail/within \
 199                          ../../../../boost/geometry/arithmetic \
 200                          ../../../../boost/geometry/geometries/concepts \
 201                          ../../../../boost/geometry/geometries \
 202                          ../../../../boost/geometry/geometries/adapted \
 203                          ../../../../boost/geometry/geometries/register \
 204                          ../../../../boost/geometry/iterators \
 205                          ../../../../boost/geometry/io/wkt \
 206                          ../../../../boost/geometry/io/svg \
 207                          ../../../../boost/geometry/policies \
 208                          ../../../../boost/geometry/policies/relate \
 209                          ../../../../boost/geometry/strategies \
 210                          ../../../../boost/geometry/strategies/concepts \
 211                          ../../../../boost/geometry/strategies/agnostic \
 212                          ../../../../boost/geometry/strategies/cartesian \
 213                          ../../../../boost/geometry/strategies/spherical \
 214                          ../../../../boost/geometry/strategies/transform \
 215                          ../../../../boost/geometry/util \
 216                          ../../../../boost/geometry/views \
 217                          ./doxygen_input/pages \
 218                          ./doxygen_input/groups
 219 INPUT_ENCODING         = UTF-8
 220 FILE_PATTERNS          = *.hpp
 221 RECURSIVE              = NO
 222 EXCLUDE                = ../../../../boost/geometry/util/builder.hpp \
 223                          ../../../../boost/geometry/algorithms/parse.hpp \
 224                          ../../../../boost/geometry/algorithms/point_on_line.hpp \
 225                          ../../../../boost/geometry/strategies/cartesian/cart_intersect.hpp \
 226                          ../../../../boost/geometry/util/distance_sort.hpp \
 227                          ./doxygen_extension_examples.hpp
 228 EXCLUDE_SYMLINKS       = NO
 229 EXCLUDE_PATTERNS       =
 230 EXCLUDE_SYMBOLS        =
 231 EXAMPLE_PATH           = . .. ../../example ../../example/with_external_libs \
 232                          doxygen_input/sourcecode \
 233                          ../../../../boost/geometry/geometries \
 234                          ../../../../boost/geometry/strategies \
 235                          ../../../../boost/geometry/strategies/cartesian \
 236                          ../../../../boost/geometry/algorithms
 237 EXAMPLE_PATTERNS       =
 238 EXAMPLE_RECURSIVE      = NO
 239 IMAGE_PATH             = doxygen_input/images
 240 INPUT_FILTER           =
 241 FILTER_PATTERNS        =
 242 FILTER_SOURCE_FILES    = NO
 243 #---------------------------------------------------------------------------
 244 # configuration options related to source browsing
 245 #---------------------------------------------------------------------------
 246 SOURCE_BROWSER         = NO
 247 INLINE_SOURCES         = NO
 248 STRIP_CODE_COMMENTS    = YES
 249 REFERENCED_BY_RELATION = NO
 250 REFERENCES_RELATION    = NO
 251 REFERENCES_LINK_SOURCE = NO
 252 USE_HTAGS              = NO
 253 VERBATIM_HEADERS       = NO
 254 #---------------------------------------------------------------------------
 255 # configuration options related to the alphabetical class index
 256 #---------------------------------------------------------------------------
 257 COLS_IN_ALPHA_INDEX    = 3
 258 IGNORE_PREFIX          =
 259 #---------------------------------------------------------------------------
 260 # configuration options related to the HTML output
 261 #---------------------------------------------------------------------------
 262 GENERATE_HTML          = YES
 263 HTML_OUTPUT            = html_by_doxygen
 264 HTML_FILE_EXTENSION    = .html
 265 HTML_HEADER            = doxygen_input/ggl_doxygen_header.html
 266 HTML_FOOTER            = doxygen_input/ggl_doxygen_footer.html
 267 HTML_STYLESHEET        =
 268 GENERATE_HTMLHELP      = NO
 269 GENERATE_DOCSET        = NO
 270 DOCSET_FEEDNAME        = "Generated documentation, by Doxygen"
 271 DOCSET_BUNDLE_ID       = org.doxygen.Project
 272 HTML_DYNAMIC_SECTIONS  = NO
 273 CHM_FILE               =
 274 HHC_LOCATION           =
 275 GENERATE_CHI           = NO
 276 BINARY_TOC             = NO
 277 TOC_EXPAND             = NO
 278 DISABLE_INDEX          = NO
 279 ENUM_VALUES_PER_LINE   = 4
 280 GENERATE_TREEVIEW      = NO
 281 TREEVIEW_WIDTH         = 250
 282
 283 #---------------------------------------------------------------------------
 284 # configuration options related to the XML output
 285 #---------------------------------------------------------------------------
 286 GENERATE_XML           = YES
 287 XML_OUTPUT             = xml
 288 XML_SCHEMA             =
 289 XML_DTD                =
 290 XML_PROGRAMLISTING     = NO
 291
 292 #---------------------------------------------------------------------------
 293 # Configuration options turned off
 294 #---------------------------------------------------------------------------
 295 GENERATE_LATEX         = NO
 296 GENERATE_MAN           = NO
 297 GENERATE_RTF           = NO
 298 GENERATE_AUTOGEN_DEF   = NO
 299 GENERATE_PERLMOD       = NO
 300
 301
 302 #---------------------------------------------------------------------------
 303 # Configuration options related to the preprocessor
 304 #---------------------------------------------------------------------------
 305 ENABLE_PREPROCESSING   = YES
 306 MACRO_EXPANSION        = YES
 307 EXPAND_ONLY_PREDEF     = YES
 308 SEARCH_INCLUDES        = YES
 309 INCLUDE_PATH           =
 310 INCLUDE_FILE_PATTERNS  =
 311 PREDEFINED             = BOOST_CONCEPT_REQUIRES(x)= \
 312                          BOOST_CONCEPT_ASSERT(x) = \
 313                          BOOST_STATIC_ASSERT(x) = \
 314                          DOXYGEN_SHOULD_SKIP_THIS \
 315                          DOXYGEN_NO_DISPATCH \
 316                          DOXYGEN_NO_IMPL \
 317                          DOXYGEN_NO_DETAIL \
 318                          DOXYGEN_NO_CONCEPT_MEMBERS \
 319                          DOXYGEN_NO_TRAITS_SPECIALIZATIONS \
 320                          DOXYGEN_NO_STRATEGY_SPECIALIZATIONS \
 321                          DOXYGEN_NO_SPECIALIZATIONS \
 322                          DOXYGEN_INVOKED
 323 EXPAND_AS_DEFINED      =
 324 SKIP_FUNCTION_MACROS   = YES
 325
 326
 327 #---------------------------------------------------------------------------
 328 # Configuration::additions related to the search engine
 329 #---------------------------------------------------------------------------
 330 SEARCHENGINE           = NO