diff --git a/doc/docca/README.md b/doc/docca/README.md deleted file mode 100644 index ab7aa9ef..00000000 --- a/doc/docca/README.md +++ /dev/null @@ -1,4 +0,0 @@ -# docca -Boost.Book XSLT C++ documentation system - -[Example Documentation](http://vinniefalco.github.io/docca/) diff --git a/doc/docca/example/.gitignore b/doc/docca/example/.gitignore deleted file mode 100644 index fc40be01..00000000 --- a/doc/docca/example/.gitignore +++ /dev/null @@ -1,5 +0,0 @@ -bin -html -temp -reference.qbk -out.txt diff --git a/doc/docca/example/Jamfile b/doc/docca/example/Jamfile deleted file mode 100644 index 61d564f0..00000000 --- a/doc/docca/example/Jamfile +++ /dev/null @@ -1,65 +0,0 @@ -# -# Copyright (c) 2013-2016 Vinnie Falco (vinnie dot falco at gmail dot com) -# -# Distributed under the Boost Software License, Version 1.0. (See accompanying -# file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) -# - -import os ; - -local broot = [ os.environ BOOST_ROOT ] ; - -project docca/doc ; - -using boostbook ; -using quickbook ; -using doxygen ; - -xml docca_bb : main.qbk ; - -path-constant out : . ; - -install stylesheets - : - $(broot)/doc/src/boostbook.css - : - $(out)/html - ; - -explicit stylesheets ; - -install images - : - [ glob $(broot)/doc/src/images/*.png ] - : - $(out)/html/images - ; - -explicit images ; - -install callouts - : - [ glob $(broot)/doc/src/images/callouts/*.png ] - : - $(out)/html/images/callouts - ; - -explicit callout ; - -boostbook doc - : - docca_bb - : - chapter.autolabel=0 - boost.root=$(broot) - chapter.autolabel=0 - chunk.first.sections=1 # Chunk the first top-level section? - chunk.section.depth=8 # Depth to which sections should be chunked - generate.section.toc.level=1 # Control depth of TOC generation in sections - toc.max.depth=2 # How many levels should be created for each TOC? - toc.section.depth=2 # How deep should recursive sections appear in the TOC? - : - temp - stylesheets - images - ; diff --git a/doc/docca/example/boostbook.dtd b/doc/docca/example/boostbook.dtd deleted file mode 100644 index bd4c3f87..00000000 --- a/doc/docca/example/boostbook.dtd +++ /dev/null @@ -1,439 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -%DocBook; diff --git a/doc/docca/example/include/docca/example.hpp b/doc/docca/example/include/docca/example.hpp deleted file mode 100644 index f1591357..00000000 --- a/doc/docca/example/include/docca/example.hpp +++ /dev/null @@ -1,857 +0,0 @@ -// -// Copyright (c) 2015-2016 Vinnie Falco (vinnie dot falco at gmail dot com) -// -// Distributed under the Boost Software License, Version 1.0. (See accompanying -// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) -// - -#ifndef EXAMPLE_HPP -#define EXAMPLE_HPP - -#include -#include - -// This is a sample header file to show docca XLST results -// -// namespace, enum, type alias, global, static global, -// function, static function, struct/class - -namespace example { - -/** Enum - - Description -*/ -enum enum_t -{ - /// 0 - zero, - - /// 1 - one, - - /// 2 - two -}; - -/** Enum class - - Description -*/ -enum class enum_c -{ - /// aaa - aaa, - - /// bbb - bbb, - - /// ccc - ccc -}; - -/** Type alias - - Description -*/ -using type = std::string; - -/** Template type alias - - Description -*/ -template -using t_type = std::vector; - -/** Void or deduced - - Description -*/ -using vod = __deduced__; - -/** See below - - Description -*/ -using sb = __see_below__; - -/** Implementation-defined - - Description -*/ -using impdef = __implementation_defined__; - -/** Variable - - Description -*/ -extern std::size_t var; - -/** Static variable - - Description -*/ -static std::size_t s_var = 0; - -/** Brief with @b bold text. - - Function returning @ref type. - - @return The type - - @see t_func. - - @throw std::exception on error - @throw std::domain_error on bad parameters - - @par Thread Safety - - Cannot be called concurrently. - - @note Additional notes. - - @param arg1 Function parameter 1 - @param arg2 Function parameter 2 -*/ -type -func(int arg1, std::string arg2); - -/** Brief for function starting with _ - - @return @ref type - - @see func -*/ -type -_func(float arg1, std::size arg2); - -/** Brief. - - Function description. - - See @ref func. - - @tparam T Template parameter 1 - @tparam U Template parameter 2 - @tparam V Template parameter 3 - - @param t Function parameter 1 - @param u Function parameter 2 - @param v Function parameter 3 - - @return nothing -*/ -template -void -t_func(T t, U const& u, V&& v); - -/** Overloaded function 1 - - Description - - @param arg1 Parameter 1 -*/ -void -overload(int arg1); - -/** Overloaded function 2 - - Description - - @param arg1 Parameter 1 - @param arg2 Parameter 2 -*/ -void -overload(int arg1, int arg2); - -/** Overloaded function 3 - - Description - - @param arg1 Parameter 1 - @param arg2 Parameter 2 - @param arg3 Parameter 3 -*/ -void -overload(int arg1, int arg2, int arg3); - -/** Markdown examples - - @par List - - 1. Lists with extra long lines that can *span* multiple lines - and overflow even the longest of buffers. - 2. With Numbers - + Or not - + Nesting - 1. Deeply - + And returning `here`. - - Another list I enjoy: - - -# 1 - - 1.a - -# 1.a.1 - -# 1.a.2 - - 1.b - -# 2 - - 2.a - - 2.b - -# 2.b.1 - -# 2.b.2 - - 2.b.2.a - - 2.b.2.b - - @par Table - - First Header | Second Header - ------------- | ------------- - Content Cell | Content Cell - Content Cell | Content Cell -*/ -void markdown(); - -//------------------------------------------------------------------------------ - -namespace detail { - -/** Detail class - - Description -*/ -struct detail_type -{ -}; - -/** Detail function - - Description -*/ -void -detail_function(); - -} // detail - -//------------------------------------------------------------------------------ - -/// Nested namespace -namespace nested { - -/** Enum - - Description -*/ -enum enum_t -{ - /// 0 - zero, - - /// 1 - one, - - /// 2 - two -}; - -/** Enum class - - Description -*/ -enum class enum_c -{ - /// aaa - aaa, - - /// bbb - bbb, - - /// ccc - ccc -}; - -/** Type alias - - Description -*/ -using type = std::string; - -/** Template type alias - - Description -*/ -template -using t_type = std::vector; - -/** Variable - - Description -*/ -extern std::size_t var; - -/** Static variable - - Description -*/ -static std::size_t s_var = 0; - -/** Brief with @b bold text. - - Function returning @ref type. - - @return The type - - @see t_func. - - @throw std::exception on error - @throw std::domain_error on bad parameters - - @par Thread Safety - - Cannot be called concurrently. - - @note Additional notes. - - @param arg1 Function parameter 1 - @param arg2 Function parameter 2 -*/ -type -func(int arg1, std::string arg2); - -/** Brief for function starting with _ - -@return @ref type - -@see func -*/ -type -_func(float arg1, std::size arg2); - -/** Brief. - - Function description. - - See @ref func. - - @tparam T Template parameter 1 - @tparam U Template parameter 2 - @tparam V Template parameter 3 - - @param t Function parameter 1 - @param u Function parameter 2 - @param v Function parameter 3 - - @return nothing -*/ -template -void -t_func(T t, U const& u, V&& v); - -/** Overloaded function 1 - - Description - - @param arg1 Parameter 1 -*/ -void -overload(int arg1); - -/** Overloaded function 2 - - Description - - @param arg1 Parameter 1 - @param arg2 Parameter 2 -*/ -void -overload(int arg1, int arg2); - -/** Overloaded function 3 - - Description - - @param arg1 Parameter 1 - @param arg2 Parameter 2 - @param arg3 Parameter 3 -*/ -void -overload(int arg1, int arg2, int arg3); - -} // nested - -/// Overloads operators -struct Num -{ - - /// Addition - friend - Num - operator +(Num, Num); - - /// Subtraction - friend - Num - operator -(Num, Num); - - /// Multiplication - friend - Num - operator *(Num, Num); - - /// Division - friend - Num - operator /(Num, Num); - -}; - -/// @ref Num addition -Num -operator +(Num, Num); - -/// @ref Num subtraction -Num -operator -(Num, Num); - -/// @ref Num multiplication -Num -operator *(Num, Num); - -/// @ref Num division -Num -operator /(Num, Num); - -/** Template class type. - - Description. - - @tparam T Template parameter 1 - @tparam U Template parameter 2 -*/ -template -class class_type -{ -public: - /** Enum - - Description - */ - enum enum_t - { - /// 0 - zero, - - /// 1 - one, - - /// 2 - two, - - /// _3 - _three - }; - - /** Enum class - - Description - */ - enum class enum_c - { - /// aaa - aaa, - - /// bbb - bbb, - - /// ccc - ccc, - - /// _ddd - _ddd - }; - - /** Type alias - - Description - */ - using type = std::string; - - /** Template type alias - - Description - */ - template - using t_type = std::vector; - - /** Variable - - Description - */ - extern std::size_t var; - - /** Static variable - - Description - */ - static std::size_t s_var = 0; - - /** Default Ctor - - Description - */ - class_type(); - - /** Dtor - - Description - */ - ~class_type(); - - /** Brief with @b bold text. - - Function returning @ref type. - - @return The type - - @see t_func. - - @throw std::exception on error - @throw std::domain_error on bad parameters - - @par Thread Safety - - Cannot be called concurrently. - - @note Additional notes. - - @param arg1 Function parameter 1 - @param arg2 Function parameter 2 - */ - type - func(int arg1, std::string arg2); - - /** Brief. - - Function description. - - See @ref func. - - @tparam T Template parameter 1 - @tparam U Template parameter 2 - @tparam V Template parameter 3 - - @param t Function parameter 1 - @param u Function parameter 2 - @param v Function parameter 3 - - @return nothing - */ - template - void - t_func(T t, U const& u, V&& v); - - /** Overloaded function 1 - - Description - - @param arg1 Parameter 1 - */ - void - overload(int arg1); - - /** Overloaded function 2 - - Description - - @param arg1 Parameter 1 - @param arg2 Parameter 2 - */ - void - overload(int arg1, int arg2); - - /** Overloaded function 3 - - Description - - @param arg1 Parameter 1 - @param arg2 Parameter 2 - @param arg3 Parameter 3 - */ - void - overload(int arg1, int arg2, int arg3); - - /** Less-than operator - - Description - */ - bool - operator< (class_type const& rhs) const; - - /** Greater-than operator - - Description - */ - bool - operator> (class_type const& rhs) const; - - /** Less-than-or-equal-to operator - - Description - */ - bool - operator<= (class_type const& rhs) const; - - /** Greater-than-or-equal-to operator - - Description - */ - bool - operator>= (class_type const& rhs) const; - - /** Equality operator - - Description - */ - bool - operator== (class_type const& rhs) const; - - /** Inequality operator - - Description - */ - bool - operator!= (class_type const& rhs) const; - - /** Arrow operator - - Description - */ - std::size_t operator->() const; - - /** Index operator - - Description - */ - enum_c& operator[](std::size_t); - - /** Index operator - - Description - */ - enum_c operator[](std::size_t) const; - - /// Public data - std::size_t pub_data_; - - /// Public static data - static std::size_t pub_sdata_; - -protected: - /** Protected data - - Description - */ - std::size_t prot_data_; - - /** Protected enum - - Description - */ - enum_c _prot_enum; - - /** Static protected data - - Description - */ - static std::size_t prot_sdata_; - - /** Protected type - - Description - */ - struct prot_type - { - }; - - /** Protected function - - Description - */ - void prot_memfn(); - - /** Protected function returning @ref prot_type - - Description - */ - prot_type prot_rvmemfn(); - - /** Protected static member function - - Description - */ - static void static_prot_memfn(); - -private: - /** Private data - - Description - */ - std::size_t priv_data_; - - /** Static private data - - Description - */ - static std::size_t priv_sdata_; - - /** Private type - - Description - */ - struct priv_type - { - }; - - /** Private function - - Description - */ - void priv_memfn(); - - /** Private function returning *ref priv_type - - Description - */ - priv_type priv_rvmemfn(); - - /** Static private member function - - Description - */ - static void static_priv_memfn(); - - /** Friend class - - Description - */ - friend friend_class; -}; - -/// Other base class 1 -class other_base_class1 -{ -}; - -/// Other base class 2 -class other_base_class2 -{ -}; - -/** Derived type - - Description -*/ -template -class derived_type : - public class_type, - protected other_base_class1, - private other_base_class2 -{ -}; - -/** References to all identifiers: - - Description one @ref one - - @par See Also - - @li @ref type - - @li @ref t_type - - @li @ref vod - - @li @ref impdef - - @li @ref var - - @li @ref s_var - - @li @ref func - - @li @ref t_func - - @li @ref overload - - @li @ref nested::enum_t : @ref nested::zero @ref nested::one @ref nested::two - - @li @ref nested::enum_c : nested::enum_c::aaa @ref nested::enum_c::bbb @ref nested::enum_c::ccc - - @li @ref nested::type - - @li @ref nested::t_type - - @li @ref nested::var - - @li @ref nested::s_var - - @li @ref nested::func - - @li @ref nested::t_func - - @li @ref nested::overload - - @li @ref class_type - - @li @ref class_type::enum_t : @ref class_type::zero @ref class_type::one @ref class_type::two @ref class_type::_three - - @li @ref class_type::enum_c : class_type::enum_c::aaa @ref class_type::enum_c::bbb @ref class_type::enum_c::ccc class_type::enum_c::_ddd - - @li @ref class_type::type - - @li @ref class_type::t_type - - @li @ref class_type::var - - @li @ref class_type::s_var - - @li @ref class_type::class_type - - @li @ref class_type::func - - @li @ref class_type::t_func - - @li @ref class_type::overload - - @li @ref class_type::pub_data_ - - @li @ref class_type::pub_sdata_ - - @li @ref class_type::_prot_enum - - @li @ref class_type::prot_type - - @li @ref class_type::priv_type - - @li @ref derived_type - - @li @ref Num - -*/ -void all_ref(); - -} // example - -namespace other { - -/// other function -void func(); - -/// other class -struct class_type -{ -}; - - -} // other - -#endif diff --git a/doc/docca/example/index.xml b/doc/docca/example/index.xml deleted file mode 100644 index c364e4ed..00000000 --- a/doc/docca/example/index.xml +++ /dev/null @@ -1,14 +0,0 @@ - - - - - -
- Index - -
diff --git a/doc/docca/example/main.qbk b/doc/docca/example/main.qbk deleted file mode 100644 index 43ddf6ae..00000000 --- a/doc/docca/example/main.qbk +++ /dev/null @@ -1,28 +0,0 @@ -[/ - Copyright (c) 2013-2016 Vinnie Falco (vinnie dot falco at gmail dot com) - - Distributed under the Boost Software License, Version 1.0. (See accompanying - file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) -] - -[library docca - [quickbook 1.6] - [copyright 2016 Vinnie Falco] - [purpose Documentation Library] - [license - Distributed under the Boost Software License, Version 1.0. - (See accompanying file LICENSE_1_0.txt or copy at - [@http://www.boost.org/LICENSE_1_0.txt]) - ] - [category template] - [category generic] -] - -[template mdash[] '''— '''] -[template indexterm1[term1] ''''''[term1]''''''] -[template indexterm2[term1 term2] ''''''[term1]''''''[term2]''''''] - -[section:ref Reference] -[include reference.qbk] -[endsect] -[xinclude index.xml] diff --git a/doc/docca/example/makeqbk.sh b/doc/docca/example/makeqbk.sh deleted file mode 100644 index e6fa0c30..00000000 --- a/doc/docca/example/makeqbk.sh +++ /dev/null @@ -1,13 +0,0 @@ -#!/usr/bin/bash - -# Copyright (c) 2013-2016 Vinnie Falco (vinnie dot falco at gmail dot com) -# -# Distributed under the Boost Software License, Version 1.0. (See accompanying -# file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) - -mkdir -p temp -doxygen source.dox -cd temp -xsltproc combine.xslt index.xml > all.xml -xsltproc ../reference.xsl all.xml > ../reference.qbk - diff --git a/doc/docca/example/reference.xsl b/doc/docca/example/reference.xsl deleted file mode 100644 index de567529..00000000 --- a/doc/docca/example/reference.xsl +++ /dev/null @@ -1,14 +0,0 @@ - - - - - - - - - - - - - - diff --git a/doc/docca/example/source.dox b/doc/docca/example/source.dox deleted file mode 100644 index c55616ee..00000000 --- a/doc/docca/example/source.dox +++ /dev/null @@ -1,333 +0,0 @@ -#--------------------------------------------------------------------------- -# Project related configuration options -#--------------------------------------------------------------------------- -DOXYFILE_ENCODING = UTF-8 -PROJECT_NAME = "docca" -PROJECT_NUMBER = -PROJECT_BRIEF = Documentation Library -PROJECT_LOGO = -OUTPUT_DIRECTORY = -CREATE_SUBDIRS = NO -ALLOW_UNICODE_NAMES = NO -OUTPUT_LANGUAGE = English -BRIEF_MEMBER_DESC = YES -REPEAT_BRIEF = YES -ABBREVIATE_BRIEF = -ALWAYS_DETAILED_SEC = YES -INLINE_INHERITED_MEMB = YES -FULL_PATH_NAMES = NO -STRIP_FROM_PATH = include/ -STRIP_FROM_INC_PATH = -SHORT_NAMES = NO -JAVADOC_AUTOBRIEF = YES -QT_AUTOBRIEF = NO -MULTILINE_CPP_IS_BRIEF = YES -INHERIT_DOCS = YES -SEPARATE_MEMBER_PAGES = NO -TAB_SIZE = 4 -ALIASES = -TCL_SUBST = -OPTIMIZE_OUTPUT_FOR_C = NO -OPTIMIZE_OUTPUT_JAVA = NO -OPTIMIZE_FOR_FORTRAN = NO -OPTIMIZE_OUTPUT_VHDL = NO -EXTENSION_MAPPING = -MARKDOWN_SUPPORT = YES -AUTOLINK_SUPPORT = YES -BUILTIN_STL_SUPPORT = NO -CPP_CLI_SUPPORT = NO -SIP_SUPPORT = NO -IDL_PROPERTY_SUPPORT = YES -DISTRIBUTE_GROUP_DOC = NO -GROUP_NESTED_COMPOUNDS = NO -SUBGROUPING = YES -INLINE_GROUPED_CLASSES = NO -INLINE_SIMPLE_STRUCTS = NO -TYPEDEF_HIDES_STRUCT = NO -LOOKUP_CACHE_SIZE = 0 - -#--------------------------------------------------------------------------- -# Build related configuration options -#--------------------------------------------------------------------------- -EXTRACT_ALL = YES -EXTRACT_PRIVATE = YES -EXTRACT_PACKAGE = NO -EXTRACT_STATIC = YES -EXTRACT_LOCAL_CLASSES = NO -EXTRACT_LOCAL_METHODS = NO -EXTRACT_ANON_NSPACES = NO -HIDE_UNDOC_MEMBERS = NO -HIDE_UNDOC_CLASSES = NO -HIDE_FRIEND_COMPOUNDS = NO -HIDE_IN_BODY_DOCS = NO -INTERNAL_DOCS = NO -CASE_SENSE_NAMES = YES -HIDE_SCOPE_NAMES = NO -HIDE_COMPOUND_REFERENCE= NO -SHOW_INCLUDE_FILES = NO -SHOW_GROUPED_MEMB_INC = NO -FORCE_LOCAL_INCLUDES = NO -INLINE_INFO = NO -SORT_MEMBER_DOCS = NO -SORT_BRIEF_DOCS = NO -SORT_MEMBERS_CTORS_1ST = YES -SORT_GROUP_NAMES = NO -SORT_BY_SCOPE_NAME = NO -STRICT_PROTO_MATCHING = NO -GENERATE_TODOLIST = NO -GENERATE_TESTLIST = NO -GENERATE_BUGLIST = NO -GENERATE_DEPRECATEDLIST= NO -ENABLED_SECTIONS = -MAX_INITIALIZER_LINES = 30 -SHOW_USED_FILES = NO -SHOW_FILES = NO -SHOW_NAMESPACES = NO -FILE_VERSION_FILTER = -LAYOUT_FILE = -CITE_BIB_FILES = - -#--------------------------------------------------------------------------- -# Configuration options related to warning and progress messages -#--------------------------------------------------------------------------- -QUIET = NO -WARNINGS = YES -WARN_IF_UNDOCUMENTED = YES -WARN_IF_DOC_ERROR = YES -WARN_NO_PARAMDOC = NO -WARN_AS_ERROR = NO -WARN_FORMAT = "$file:$line: $text" -WARN_LOGFILE = - -#--------------------------------------------------------------------------- -# Configuration options related to the input files -#--------------------------------------------------------------------------- -INPUT = include/docca/example.hpp - -INPUT_ENCODING = UTF-8 -FILE_PATTERNS = -RECURSIVE = NO -EXCLUDE = -EXCLUDE_SYMLINKS = NO -EXCLUDE_PATTERNS = -EXCLUDE_SYMBOLS = -EXAMPLE_PATH = -EXAMPLE_PATTERNS = -EXAMPLE_RECURSIVE = YES -IMAGE_PATH = -INPUT_FILTER = -FILTER_PATTERNS = -FILTER_SOURCE_FILES = NO -FILTER_SOURCE_PATTERNS = -USE_MDFILE_AS_MAINPAGE = - -#--------------------------------------------------------------------------- -# Configuration options related to source browsing -#--------------------------------------------------------------------------- -SOURCE_BROWSER = NO -INLINE_SOURCES = NO -STRIP_CODE_COMMENTS = YES -REFERENCED_BY_RELATION = NO -REFERENCES_RELATION = NO -REFERENCES_LINK_SOURCE = YES -SOURCE_TOOLTIPS = YES -USE_HTAGS = NO -VERBATIM_HEADERS = YES -CLANG_ASSISTED_PARSING = NO -CLANG_OPTIONS = - -#--------------------------------------------------------------------------- -# Configuration options related to the alphabetical class index -#--------------------------------------------------------------------------- -ALPHABETICAL_INDEX = YES -COLS_IN_ALPHA_INDEX = 1 -IGNORE_PREFIX = - -#--------------------------------------------------------------------------- -# Configuration options related to the HTML output -#--------------------------------------------------------------------------- -GENERATE_HTML = NO -HTML_OUTPUT = dhtm -HTML_FILE_EXTENSION = .html -HTML_HEADER = -HTML_FOOTER = -HTML_STYLESHEET = -HTML_EXTRA_STYLESHEET = -HTML_EXTRA_FILES = -HTML_COLORSTYLE_HUE = 220 -HTML_COLORSTYLE_SAT = 100 -HTML_COLORSTYLE_GAMMA = 80 -HTML_TIMESTAMP = NO -HTML_DYNAMIC_SECTIONS = NO -HTML_INDEX_NUM_ENTRIES = 100 -GENERATE_DOCSET = NO -DOCSET_FEEDNAME = "Doxygen generated docs" -DOCSET_BUNDLE_ID = org.doxygen.Project -DOCSET_PUBLISHER_ID = org.doxygen.Publisher -DOCSET_PUBLISHER_NAME = Publisher -GENERATE_HTMLHELP = NO -CHM_FILE = -HHC_LOCATION = -GENERATE_CHI = NO -CHM_INDEX_ENCODING = -BINARY_TOC = NO -TOC_EXPAND = NO -GENERATE_QHP = NO -QCH_FILE = -QHP_NAMESPACE = org.doxygen.Project -QHP_VIRTUAL_FOLDER = doc -QHP_CUST_FILTER_NAME = -QHP_CUST_FILTER_ATTRS = -QHP_SECT_FILTER_ATTRS = -QHG_LOCATION = -GENERATE_ECLIPSEHELP = NO -ECLIPSE_DOC_ID = org.doxygen.Project -DISABLE_INDEX = NO -GENERATE_TREEVIEW = NO -ENUM_VALUES_PER_LINE = 4 -TREEVIEW_WIDTH = 250 -EXT_LINKS_IN_WINDOW = NO -FORMULA_FONTSIZE = 10 -FORMULA_TRANSPARENT = YES -USE_MATHJAX = NO -MATHJAX_FORMAT = HTML-CSS -MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest -MATHJAX_EXTENSIONS = -MATHJAX_CODEFILE = -SEARCHENGINE = YES -SERVER_BASED_SEARCH = NO -EXTERNAL_SEARCH = NO -SEARCHENGINE_URL = -SEARCHDATA_FILE = searchdata.xml -EXTERNAL_SEARCH_ID = -EXTRA_SEARCH_MAPPINGS = - -#--------------------------------------------------------------------------- -# Configuration options related to the LaTeX output -#--------------------------------------------------------------------------- -GENERATE_LATEX = NO -LATEX_OUTPUT = latex -LATEX_CMD_NAME = latex -MAKEINDEX_CMD_NAME = makeindex -COMPACT_LATEX = NO -PAPER_TYPE = a4 -EXTRA_PACKAGES = -LATEX_HEADER = -LATEX_FOOTER = -LATEX_EXTRA_STYLESHEET = -LATEX_EXTRA_FILES = -PDF_HYPERLINKS = YES -USE_PDFLATEX = YES -LATEX_BATCHMODE = NO -LATEX_HIDE_INDICES = NO -LATEX_SOURCE_CODE = NO -LATEX_BIB_STYLE = plain -LATEX_TIMESTAMP = NO - -#--------------------------------------------------------------------------- -# Configuration options related to the RTF output -#--------------------------------------------------------------------------- -GENERATE_RTF = NO -RTF_OUTPUT = rtf -COMPACT_RTF = NO -RTF_HYPERLINKS = NO -RTF_STYLESHEET_FILE = -RTF_EXTENSIONS_FILE = -RTF_SOURCE_CODE = NO - -#--------------------------------------------------------------------------- -# Configuration options related to the man page output -#--------------------------------------------------------------------------- -GENERATE_MAN = NO -MAN_OUTPUT = man -MAN_EXTENSION = .3 -MAN_SUBDIR = -MAN_LINKS = NO - -#--------------------------------------------------------------------------- -# Configuration options related to the XML output -#--------------------------------------------------------------------------- -GENERATE_XML = YES -XML_OUTPUT = temp/ -XML_PROGRAMLISTING = NO - -#--------------------------------------------------------------------------- -# Configuration options related to the DOCBOOK output -#--------------------------------------------------------------------------- -GENERATE_DOCBOOK = NO -DOCBOOK_OUTPUT = docbook -DOCBOOK_PROGRAMLISTING = NO - -#--------------------------------------------------------------------------- -# Configuration options for the AutoGen Definitions output -#--------------------------------------------------------------------------- -GENERATE_AUTOGEN_DEF = NO -GENERATE_PERLMOD = NO -PERLMOD_LATEX = NO -PERLMOD_PRETTY = YES -PERLMOD_MAKEVAR_PREFIX = - -#--------------------------------------------------------------------------- -# Configuration options related to the preprocessor -#--------------------------------------------------------------------------- -ENABLE_PREPROCESSING = YES -MACRO_EXPANSION = YES -EXPAND_ONLY_PREDEF = YES -SEARCH_INCLUDES = YES -INCLUDE_PATH = -INCLUDE_FILE_PATTERNS = -PREDEFINED = DOXYGEN \ - GENERATING_DOCS \ - _MSC_VER - -EXPAND_AS_DEFINED = -SKIP_FUNCTION_MACROS = YES - -#--------------------------------------------------------------------------- -# Configuration options related to external references -#--------------------------------------------------------------------------- -TAGFILES = -GENERATE_TAGFILE = -ALLEXTERNALS = NO -EXTERNAL_GROUPS = YES -EXTERNAL_PAGES = YES -PERL_PATH = /usr/bin/perl - -#--------------------------------------------------------------------------- -# Configuration options related to the dot tool -#--------------------------------------------------------------------------- -CLASS_DIAGRAMS = NO -MSCGEN_PATH = -DIA_PATH = -HIDE_UNDOC_RELATIONS = YES -HAVE_DOT = NO -DOT_NUM_THREADS = 0 -DOT_FONTNAME = Helvetica -DOT_FONTSIZE = 10 -DOT_FONTPATH = -CLASS_GRAPH = YES -COLLABORATION_GRAPH = YES -GROUP_GRAPHS = YES -UML_LOOK = NO -UML_LIMIT_NUM_FIELDS = 10 -TEMPLATE_RELATIONS = NO -INCLUDE_GRAPH = YES -INCLUDED_BY_GRAPH = YES -CALL_GRAPH = NO -CALLER_GRAPH = NO -GRAPHICAL_HIERARCHY = YES -DIRECTORY_GRAPH = YES -DOT_IMAGE_FORMAT = png -INTERACTIVE_SVG = NO -DOT_PATH = -DOTFILE_DIRS = -MSCFILE_DIRS = -DIAFILE_DIRS = -PLANTUML_JAR_PATH = -PLANTUML_INCLUDE_PATH = -DOT_GRAPH_MAX_NODES = 50 -MAX_DOT_GRAPH_DEPTH = 0 -DOT_TRANSPARENT = NO -DOT_MULTI_TARGETS = NO -GENERATE_LEGEND = YES -DOT_CLEANUP = YES diff --git a/doc/docca/include/docca/doxygen.xsl b/doc/docca/include/docca/doxygen.xsl deleted file mode 100644 index 7c192da8..00000000 --- a/doc/docca/include/docca/doxygen.xsl +++ /dev/null @@ -1,1992 +0,0 @@ - - - - - - - - - - - - - - - - - - - - [/ - Copyright (c) 2013-2016 Vinnie Falco (vinnie dot falco at gmail dot com) - - Distributed under the Boost Software License, Version 1.0. (See accompanying - file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) -] - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - * - - - - & - - - - &... - - - - && - - - - &&... - - - - - - - - - - - - - - - - - - - - - - - - - - - ``['implementation-defined]`` - - - ``['see-below]`` - - - ``__deduced__`` - - - ``__deduced__`` - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - [heading - - ] - - - - - [@ - - - - ] - - - - - ``` - - ``` - - - - [role red error.programlisting] - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - ` - - ` - - - ` - - ` - - - - - - - - - - - - - - - - - - - - - # - - - * - - - - - -[*] - -['] - - - - - - [heading Exceptions] - [table [[Type][Thrown On]] - - - [heading Parameters] - [table [[Name][Description]] - - - [heading Template Parameters] - [table [[Type][Description]] - - - [table [[Name][Description]] - - - - ] - - - - - [[` - - `][ - - - - ]] - - - - - [table - - ] - - - - [ - - ] - - - - [ - - ] - - - - - - - [heading Return Value] - - - - [heading See Also] - - - - [heading Remarks] - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - \_ - - - - - - - - - - - - - - - - - \[ - - - - - - - \] - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - :: - - - - - - - |1a| - [link - - ` - - `] - - [heading Debug] [table [[name][value]] - - - - - - - - - - - - - - - - - - - - - - - - :: - - - - - - - - - |1b| - [link - - ` - - `] - - - |1c| - [link - - ` - - `] - - - [role red - |1| - - - ] - - - - [heading Debug] [table [[name][value]] - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - |2| - [link - - ` - - `] - - - [role red - |2| - - ] - - - - [heading Debug] [table [[name][value]] - - - - - - - - - - - - - - - [role red - |6| - - ] - - - - - - - - - - - - - - - - - - - - - - - - - - [link - - - - - - - - - ` - - `] - - - [link - - ` - - `] - - - [role red - |8| - - ] - - - - - [role red - |9| - - ] - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - [section: - - - - ] - - [heading Synopsis] - - - - ``` - - - - - - : - - - - - - - - - - , - - - - ``` - - - - - [heading Description] - - - - - - - - - -[endsect] - - - - - - - [heading Types] - [table [[Name][Description]] - - - [ - - - [[link - - - . - - [* - - ]]] [ - - - - ] - - - - - - - - - - - - - - [[link - - [* - - ]]] [ - - ] - - - ] - - ] - - - [heading Member Functions] - [table [[Name][Description]] - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - [ - [[link - . - [* - - ]]] [ - - - - - - - - ] ] - - - ] - - - [heading Protected Member Functions] - [table [[Name][Description]] - - - - - - - - - - - - - - - - - - - - - - - - - [ - [[link - . - [* - - ]]] [ - - - - - - - - ] ] - - - ] - - - [heading Private Member Functions] - [table [[Name][Description]] - - - - - - - - - - - - - - - - - - - - - - - - - [ - [[link - . - [* - - ]]] [ - - - - - - - - ] ] - - - ] - - - [heading Data Members] - [table [[Name][Description]] - - - [ - [[link - . - [* - - ]]] [ - - ] ] - - ] - - - [heading Protected Data Members] - [table [[Name][Description]] - - - [ - [[link - . - [* - - ]]] [ - - ] ] - - ] - - - [heading Private Data Members] - [table [[Name][Description]] - - - [ - [[link - . - [* - - ]]] [ - - ] ] - - ] - - - [heading Friends] - [table [[Name][Description]] - - - - - - - - - - - - - - - - - - - - - - - - - [ - [[link - - - - - . - - - - [* - - ]]] [ - - - - - - - - ] ] - - - ] - - - [heading Related Functions] - [table [[Name][Description]] - - - - - - - - - - - - - - - - - - - - - - - - - [ - [[link . - [*]]] - [ - - - - - - - - - ] - ] - - - - ] - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - [section: - - - - :: - - ] - [indexterm2 - - .. - - ] - - ``` - - - - - ``` - - ``` - - - - explicit - friend - static - virtual - - - - - - - - - - ``[link - - . - - .overload - - - - ]``( - - ) - - const - - ; - - ``[''''&raquo;''' - [link - - . - - .overload - - more...]]`` - - - - ``` - - - - [section: - - - - - overload - - - - - :: - - - ( - - of - - overloads) - - ] - - - - (Inherited from ` - - - - - `) - - - - [indexterm2 - - .. - - ] - - - [heading Synopsis] - - - - - - - - - - - - - - - - - - - - - ``` - - ``` - - - ``` - - ``` - - - [heading Description] - - - - - - - - - [endsect] [endsect] - - - [endsect] - - - - - - - - - ``` - - using - - = - - - - - - - - - ; - ``` - - - - - - - - - - - - - - - - - - - - - - - - - - - - ``` - - static - - - - - - - - - ; ``` - - - - - - - ``` - enum - - ``` - - - - [indexterm2 - - .. - - ] - - - [heading Values] - [table [[Name][Description]] - - [[[^ - - ]][ - - - - ]] - - ] - - - - - - - - - - - - - - - - - - - - - - - static - virtual - - - - - - ( - - ) - const - ; - - - - - - template< - - > - - - - - - - - - - - - - - class - - - [role red error.class-detail-template.1] - - - - - - - - - - - - - [role red error.class-detail-template.2] - - - - - - - - - - - - = - - - - - , - - - - - - - - - (& - - ) - - - - - - - - - - - - - - = - - - - , - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - [section: - - - - ] - [indexterm1 - - ] - - - - - - - - - - - - ``` - - - - - ``` - - ``` - - - - - - - - - - - - - ``[link - - .overload - - - - ]``( - - ); - - ``[''''&raquo;''' - [link - - .overload - - more...]]`` - - - - ``` - - - - - - [section: - - - - [section: - overload - - - - - - ( - - of - - overloads) - - ] - - [indexterm1 - - ] - - - [heading Synopsis] - - - - - - - - - - - - [heading Description] - - - - - - - - - - - - - - - ``` - - ``` - - - [heading Description] - - - [heading Debug] [table [[name][value]] - - - - - - - - - - - - - - - - - - [endsect] [endsect] - - - [endsect] - - - - -