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