[libdoxygen-filter-perl] 01/02: Import Upstream version 1.72
Francesco Lovergine
frankie at moszumanska.debian.org
Sun Dec 31 10:51:23 UTC 2017
This is an automated email from the git hooks/post-receive script.
frankie pushed a commit to branch master
in repository libdoxygen-filter-perl.
commit 66f7ea30cc8681b3d00a1a08c4015209614ec0d7
Author: Francesco Paolo Lovergine <frankie at debian.org>
Date: Sun Dec 31 11:46:31 2017 +0100
Import Upstream version 1.72
---
Changes | 132 +++
Doxyfile | 2393 ++++++++++++++++++++++++++++++++++++++++
HISTORY | 26 +
LICENSE | 202 ++++
MANIFEST | 14 +
META.json | 45 +
META.yml | 26 +
Makefile.PL | 18 +
README.md | 51 +
bin/doxygen-filter-perl | 79 ++
lib/Doxygen/Filter.pm | 53 +
lib/Doxygen/Filter/Perl.pm | 1281 +++++++++++++++++++++
lib/Doxygen/Filter/Perl/POD.pm | 94 ++
t/version.t | 101 ++
14 files changed, 4515 insertions(+)
diff --git a/Changes b/Changes
new file mode 100644
index 0000000..e535e8c
--- /dev/null
+++ b/Changes
@@ -0,0 +1,132 @@
+Release Notes:
+v1.72 - 2015-03-23
+ Changes
+ Un-did change from 1.71 and fixed it correctly by changing the Doxyfile
+v1.71 - 2015-03-16
+ Chnaged
+ Fix issue where public objects were not showing up, if a private objects was found
+v1.70 - 2015-03-16
+ Changes
+ Moved repo from sourceforge to github at https://github.com/jordan2175/doxygen-filter-perl
+ Converted to an Apache 2 license
+ Updated Doxyfile to work with latest version of Doxygen, 1.8.9.1
+ Stefan Tauner to address hash marks showing up at the last element of an array, $#array
+ Patch from Sebastian Rose to address spacing and indentation in code examples
+ Patch from Mihai MOJE to address method comments all on the same line.
+v1.62 - 2014-02-04
+ Changes
+ Zbynek Vyskovsky submitted a patch to fix the following issues and add the
+ following functionality:
+ Fix issue with white spaces and empty lines in comments
+ Added more flexibility regarding the types of attributes. Now it's not only
+ possible to specify variable type as scalar, hash or array, but in general
+ any type like void, int or in package::Class format. The same applies for
+ methods where it's now possible to specify return type of the method in
+ similar way.
+ Added error reporting in case of incorrect syntax
+ Removed dependency for the ~~ operator
+ Attributes and methods now understand static and const keyword and passes them
+ to doxygen. For global variables it automatically adds static.
+ Order of methods/functions is now kept and left up to doxygen to reorganize
+ the order if needed.
+ @fn/@function now stands for static function and it's automatically added,
+ @method is always instance method (unless explicitly mentioning static).
+v1.61 - 2013-09-23
+ Changes
+ Zbynek Vyskovsky submitted a patch to fix the following issues:
+ for top level classes (main especially) the generated class name was empty
+ @var were processed but not printed to the output
+v1.60 - 2013-08-14
+ Changes
+ Zbynek Vyskovsky submitted a patch to fix the following issues:
+ Sometimes the annotations were not processed at all, sometimes there were
+ unexpected "main" classes.
+ Additionally the processing of inheritance was hardcoded to always include
+ parent package instead of checking for presence of @ISA variable or "base" module.
+ There were also several problems caused misunderstanding of generated code by
+ doxygen as there is no equivalent of some perl packages constructs in C++.
+v1.50 - 2012-07-06
+ Changes
+ Fixed issue with last commit generating a class when it should not. Patch
+ was submitted by Yuri D'Elia - SVN ID 84
+ Added support to capture locally defined variables/arrays/hashes and print
+ them out in Doxygen format. Patch submitted by Yuri D'Elia - SVN ID 85
+ Added support for single in-line doxygen comments based on patch from Yuri D'Elia
+ Increased the version number to remove confusion about older no longer supported
+ versions of Perl filters for Doxygen
+v1.02 - 2012-04-13
+ Changes
+ Fixed issue where we would define a parent class when there was not one. This
+ patch was submitted by Yuri D'Elia
+
+v1.01 - 2012-01-18
+ Changes
+ Fixed issue where perl scripts were not getting documented correctly
+
+v1.00 - GA Release (2011-12-22)
+ Changes
+ Added some code documentation and performed some minor code cleanup
+
+v0.99_24 - Release Candidate 4 (2011-12-21)
+ Changes
+ Fixed more issues with counting subroutines
+ Fixed issue where doxygen section comment blocks were not showing up right
+
+v0.99_23 - Release Candidate 3 (2011-12-19)
+ Changes
+ Fixed issue where comments were getting stripped accidentally when found in pattern match
+
+v0.99_22 - Release Candidate 2 (2011-12-19)
+ Changes
+ Fixed issue where POD comments with special Doxygen characters caused problems
+ Fixed issue where POD multi-word section headers did not print correctly
+ Fixed issue with subroutine processing
+
+v0.99_21 - Release Candidate 1 (2011-12-13)
+ Changes
+ Fixed some issues with supporting POD
+ Did some code cleanup
+
+v0.99_11 - Beta Release 1 (unreleased)
+ New Features
+ Added basic support for POD
+
+v0.99_03 - Alpha Release 3 (unreleased)
+ Changes
+ Fixed issues with VERSION harvesting, short filenames, windows paths, spacing around
+ method and function names etc. Thanks to Hoppfrosch (hoppfrosch at gmx littledot de)
+ for the patch and suggestions
+ Cleaned up state machine and added ability to keep track or previous states
+ Integrated Log4perl debugging
+ New Features
+ Started adding support for POD processing
+
+v0.99_02 - Alpha Release 2 (2011-10-25)
+ Changes
+ Lots of code clean up
+ Added support for the following structural indicators
+ @class
+ @section
+ @subsection
+ General comments with a @brief
+ Fixed the output so that additional comments like @section blocks show up
+ correctly and in the right place.
+
+v0.99_01 - Initial Alpha Release (2011-10-21)
+ Differences from DoxyGenFilter
+ This represents a complete rewrite of the code and attempts to provide
+ a frame work from which we can greatly expand the functionality over time.
+ We also build up a document object of the code that allows us to pull things
+ in from various places and relate them all correctly.
+ New Features
+ We current support the following doxygen structural indicators
+ @file
+ @fn (@function and @method)
+ All section indicators should work under each structural indicators that we support
+ Verbatim formatting keeps comment "#" tags
+ We use the VERSION variable from the code in the file output definition
+ The @method and @function documentation blocks can reside inside or outside
+ the actual subroutines that they are tied to.
+ Known Issues
+ POD support is not yet included
+ Only two structural indicators are currently supported - more to com
diff --git a/Doxyfile b/Doxyfile
new file mode 100644
index 0000000..65adeaf
--- /dev/null
+++ b/Doxyfile
@@ -0,0 +1,2393 @@
+# Doxyfile 1.8.9.1
+
+# This file describes the settings to be used by the documentation system
+# doxygen (www.doxygen.org) for a project.
+#
+# All text after a double hash (##) is considered a comment and is placed in
+# front of the TAG it is preceding.
+#
+# All text after a single hash (#) is considered a comment and will be ignored.
+# The format is:
+# TAG = value [value, ...]
+# For lists, items can also be appended using:
+# TAG += value [value, ...]
+# Values that contain spaces should be placed between quotes (\" \").
+
+#---------------------------------------------------------------------------
+# Project related configuration options
+#---------------------------------------------------------------------------
+
+# This tag specifies the encoding used for all characters in the config file
+# that follow. The default is UTF-8 which is also the encoding used for all text
+# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv
+# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv
+# for the list of possible encodings.
+# The default value is: UTF-8.
+
+DOXYFILE_ENCODING = UTF-8
+
+# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by
+# double-quotes, unless you are using Doxywizard) that should identify the
+# project for which the documentation is generated. This name is used in the
+# title of most generated pages and in a few other places.
+# The default value is: My Project.
+
+PROJECT_NAME = Doxygen::Filter::Perl
+
+# The PROJECT_NUMBER tag can be used to enter a project or revision number. This
+# could be handy for archiving the generated documentation or if some version
+# control system is used.
+
+PROJECT_NUMBER = 1.71
+
+# Using the PROJECT_BRIEF tag one can provide an optional one line description
+# for a project that appears at the top of each page and should give viewer a
+# quick idea about the purpose of the project. Keep the description short.
+
+PROJECT_BRIEF =
+
+# With the PROJECT_LOGO tag one can specify a logo or an icon that is included
+# in the documentation. The maximum height of the logo should not exceed 55
+# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
+# the logo to the output directory.
+
+PROJECT_LOGO =
+
+# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
+# into which the generated documentation will be written. If a relative path is
+# entered, it will be relative to the location where doxygen was started. If
+# left blank the current directory will be used.
+
+OUTPUT_DIRECTORY = doc
+
+# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub-
+# directories (in 2 levels) under the output directory of each output format and
+# will distribute the generated files over these directories. Enabling this
+# option can be useful when feeding doxygen a huge amount of source files, where
+# putting all generated files in the same directory would otherwise causes
+# performance problems for the file system.
+# The default value is: NO.
+
+CREATE_SUBDIRS = NO
+
+# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII
+# characters to appear in the names of generated files. If set to NO, non-ASCII
+# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode
+# U+3044.
+# The default value is: NO.
+
+ALLOW_UNICODE_NAMES = NO
+
+# The OUTPUT_LANGUAGE tag is used to specify the language in which all
+# documentation generated by doxygen is written. Doxygen will use this
+# information to generate all constant output in the proper language.
+# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese,
+# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States),
+# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian,
+# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages),
+# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian,
+# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian,
+# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish,
+# Ukrainian and Vietnamese.
+# The default value is: English.
+
+OUTPUT_LANGUAGE = English
+
+# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member
+# descriptions after the members that are listed in the file and class
+# documentation (similar to Javadoc). Set to NO to disable this.
+# The default value is: YES.
+
+BRIEF_MEMBER_DESC = YES
+
+# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief
+# description of a member or function before the detailed description
+#
+# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
+# brief descriptions will be completely suppressed.
+# The default value is: YES.
+
+REPEAT_BRIEF = YES
+
+# This tag implements a quasi-intelligent brief description abbreviator that is
+# used to form the text in various listings. Each string in this list, if found
+# as the leading text of the brief description, will be stripped from the text
+# and the result, after processing the whole list, is used as the annotated
+# text. Otherwise, the brief description is used as-is. If left blank, the
+# following values are used ($name is automatically replaced with the name of
+# the entity):The $name class, The $name widget, The $name file, is, provides,
+# specifies, contains, represents, a, an and the.
+
+ABBREVIATE_BRIEF = "The $name class" \
+ "The $name widget" \
+ "The $name file" \
+ is \
+ provides \
+ specifies \
+ contains \
+ represents \
+ a \
+ an \
+ the
+
+# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
+# doxygen will generate a detailed section even if there is only a brief
+# description.
+# The default value is: NO.
+
+ALWAYS_DETAILED_SEC = NO
+
+# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
+# inherited members of a class in the documentation of that class as if those
+# members were ordinary class members. Constructors, destructors and assignment
+# operators of the base classes will not be shown.
+# The default value is: NO.
+
+INLINE_INHERITED_MEMB = NO
+
+# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path
+# before files name in the file list and in the header files. If set to NO the
+# shortest path that makes the file name unique will be used
+# The default value is: YES.
+
+FULL_PATH_NAMES = YES
+
+# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
+# Stripping is only done if one of the specified strings matches the left-hand
+# part of the path. The tag can be used to show relative paths in the file list.
+# If left blank the directory from which doxygen is run is used as the path to
+# strip.
+#
+# Note that you can specify absolute paths here, but also relative paths, which
+# will be relative from the directory where doxygen is started.
+# This tag requires that the tag FULL_PATH_NAMES is set to YES.
+
+STRIP_FROM_PATH = .
+
+# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
+# path mentioned in the documentation of a class, which tells the reader which
+# header file to include in order to use a class. If left blank only the name of
+# the header file containing the class definition is used. Otherwise one should
+# specify the list of include paths that are normally passed to the compiler
+# using the -I flag.
+
+STRIP_FROM_INC_PATH =
+
+# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
+# less readable) file names. This can be useful is your file systems doesn't
+# support long names like on DOS, Mac, or CD-ROM.
+# The default value is: NO.
+
+SHORT_NAMES = NO
+
+# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
+# first line (until the first dot) of a Javadoc-style comment as the brief
+# description. If set to NO, the Javadoc-style will behave just like regular Qt-
+# style comments (thus requiring an explicit @brief command for a brief
+# description.)
+# The default value is: NO.
+
+JAVADOC_AUTOBRIEF = NO
+
+# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
+# line (until the first dot) of a Qt-style comment as the brief description. If
+# set to NO, the Qt-style will behave just like regular Qt-style comments (thus
+# requiring an explicit \brief command for a brief description.)
+# The default value is: NO.
+
+QT_AUTOBRIEF = NO
+
+# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
+# multi-line C++ special comment block (i.e. a block of //! or /// comments) as
+# a brief description. This used to be the default behavior. The new default is
+# to treat a multi-line C++ comment block as a detailed description. Set this
+# tag to YES if you prefer the old behavior instead.
+#
+# Note that setting this tag to YES also means that rational rose comments are
+# not recognized any more.
+# The default value is: NO.
+
+MULTILINE_CPP_IS_BRIEF = NO
+
+# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
+# documentation from any documented member that it re-implements.
+# The default value is: YES.
+
+INHERIT_DOCS = YES
+
+# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new
+# page for each member. If set to NO, the documentation of a member will be part
+# of the file/class/namespace that contains it.
+# The default value is: NO.
+
+SEPARATE_MEMBER_PAGES = NO
+
+# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
+# uses this value to replace tabs by spaces in code fragments.
+# Minimum value: 1, maximum value: 16, default value: 4.
+
+TAB_SIZE = 4
+
+# This tag can be used to specify a number of aliases that act as commands in
+# the documentation. An alias has the form:
+# name=value
+# For example adding
+# "sideeffect=@par Side Effects:\n"
+# will allow you to put the command \sideeffect (or @sideeffect) in the
+# documentation, which will result in a user-defined paragraph with heading
+# "Side Effects:". You can put \n's in the value part of an alias to insert
+# newlines.
+
+ALIASES = "copy=\par Copyright:\n©"
+
+# This tag can be used to specify a number of word-keyword mappings (TCL only).
+# A mapping has the form "name=value". For example adding "class=itcl::class"
+# will allow you to use the command class in the itcl::class meaning.
+
+TCL_SUBST =
+
+# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
+# only. Doxygen will then generate output that is more tailored for C. For
+# instance, some of the names that are used will be different. The list of all
+# members will be omitted, etc.
+# The default value is: NO.
+
+OPTIMIZE_OUTPUT_FOR_C = NO
+
+# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
+# Python sources only. Doxygen will then generate output that is more tailored
+# for that language. For instance, namespaces will be presented as packages,
+# qualified scopes will look different, etc.
+# The default value is: NO.
+
+OPTIMIZE_OUTPUT_JAVA = NO
+
+# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
+# sources. Doxygen will then generate output that is tailored for Fortran.
+# The default value is: NO.
+
+OPTIMIZE_FOR_FORTRAN = NO
+
+# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
+# sources. Doxygen will then generate output that is tailored for VHDL.
+# The default value is: NO.
+
+OPTIMIZE_OUTPUT_VHDL = NO
+
+# Doxygen selects the parser to use depending on the extension of the files it
+# parses. With this tag you can assign which parser to use for a given
+# extension. Doxygen has a built-in mapping, but you can override or extend it
+# using this tag. The format is ext=language, where ext is a file extension, and
+# language is one of the parsers supported by doxygen: IDL, Java, Javascript,
+# C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran:
+# FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran:
+# Fortran. In the later case the parser tries to guess whether the code is fixed
+# or free formatted code, this is the default for Fortran type files), VHDL. For
+# instance to make doxygen treat .inc files as Fortran files (default is PHP),
+# and .f files as C (default is Fortran), use: inc=Fortran f=C.
+#
+# Note: For files without extension you can use no_extension as a placeholder.
+#
+# Note that for custom extensions you also need to set FILE_PATTERNS otherwise
+# the files are not read by doxygen.
+
+EXTENSION_MAPPING = pm=c++ \
+ pl=c++
+
+# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
+# according to the Markdown format, which allows for more readable
+# documentation. See http://daringfireball.net/projects/markdown/ for details.
+# The output of markdown processing is further processed by doxygen, so you can
+# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
+# case of backward compatibilities issues.
+# The default value is: YES.
+
+MARKDOWN_SUPPORT = NO
+
+# When enabled doxygen tries to link words that correspond to documented
+# classes, or namespaces to their corresponding documentation. Such a link can
+# be prevented in individual cases by putting a % sign in front of the word or
+# globally by setting AUTOLINK_SUPPORT to NO.
+# The default value is: YES.
+
+AUTOLINK_SUPPORT = NO
+
+# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
+# to include (a tag file for) the STL sources as input, then you should set this
+# tag to YES in order to let doxygen match functions declarations and
+# definitions whose arguments contain STL classes (e.g. func(std::string);
+# versus func(std::string) {}). This also make the inheritance and collaboration
+# diagrams that involve STL classes more complete and accurate.
+# The default value is: NO.
+
+BUILTIN_STL_SUPPORT = NO
+
+# If you use Microsoft's C++/CLI language, you should set this option to YES to
+# enable parsing support.
+# The default value is: NO.
+
+CPP_CLI_SUPPORT = NO
+
+# Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
+# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen
+# will parse them like normal C++ but will assume all classes use public instead
+# of private inheritance when no explicit protection keyword is present.
+# The default value is: NO.
+
+SIP_SUPPORT = NO
+
+# For Microsoft's IDL there are propget and propput attributes to indicate
+# getter and setter methods for a property. Setting this option to YES will make
+# doxygen to replace the get and set methods by a property in the documentation.
+# This will only work if the methods are indeed getting or setting a simple
+# type. If this is not the case, or you want to show the methods anyway, you
+# should set this option to NO.
+# The default value is: YES.
+
+IDL_PROPERTY_SUPPORT = YES
+
+# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
+# tag is set to YES then doxygen will reuse the documentation of the first
+# member in the group (if any) for the other members of the group. By default
+# all members of a group must be documented explicitly.
+# The default value is: NO.
+
+DISTRIBUTE_GROUP_DOC = NO
+
+# Set the SUBGROUPING tag to YES to allow class member groups of the same type
+# (for instance a group of public functions) to be put as a subgroup of that
+# type (e.g. under the Public Functions section). Set it to NO to prevent
+# subgrouping. Alternatively, this can be done per class using the
+# \nosubgrouping command.
+# The default value is: YES.
+
+SUBGROUPING = YES
+
+# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
+# are shown inside the group in which they are included (e.g. using \ingroup)
+# instead of on a separate page (for HTML and Man pages) or section (for LaTeX
+# and RTF).
+#
+# Note that this feature does not work in combination with
+# SEPARATE_MEMBER_PAGES.
+# The default value is: NO.
+
+INLINE_GROUPED_CLASSES = NO
+
+# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
+# with only public data fields or simple typedef fields will be shown inline in
+# the documentation of the scope in which they are defined (i.e. file,
+# namespace, or group documentation), provided this scope is documented. If set
+# to NO, structs, classes, and unions are shown on a separate page (for HTML and
+# Man pages) or section (for LaTeX and RTF).
+# The default value is: NO.
+
+INLINE_SIMPLE_STRUCTS = NO
+
+# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
+# enum is documented as struct, union, or enum with the name of the typedef. So
+# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
+# with name TypeT. When disabled the typedef will appear as a member of a file,
+# namespace, or class. And the struct will be named TypeS. This can typically be
+# useful for C code in case the coding convention dictates that all compound
+# types are typedef'ed and only the typedef is referenced, never the tag name.
+# The default value is: NO.
+
+TYPEDEF_HIDES_STRUCT = NO
+
+# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
+# cache is used to resolve symbols given their name and scope. Since this can be
+# an expensive process and often the same symbol appears multiple times in the
+# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
+# doxygen will become slower. If the cache is too large, memory is wasted. The
+# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
+# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
+# symbols. At the end of a run doxygen will report the cache usage and suggest
+# the optimal cache size from a speed point of view.
+# Minimum value: 0, maximum value: 9, default value: 0.
+
+LOOKUP_CACHE_SIZE = 0
+
+#---------------------------------------------------------------------------
+# Build related configuration options
+#---------------------------------------------------------------------------
+
+# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in
+# documentation are documented, even if no documentation was available. Private
+# class members and static file members will be hidden unless the
+# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
+# Note: This will also disable the warnings about undocumented members that are
+# normally produced when WARNINGS is set to YES.
+# The default value is: NO.
+
+EXTRACT_ALL = NO
+
+# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
+# be included in the documentation.
+# The default value is: NO.
+
+EXTRACT_PRIVATE = YES
+
+# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal
+# scope will be included in the documentation.
+# The default value is: NO.
+
+EXTRACT_PACKAGE = NO
+
+# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be
+# included in the documentation.
+# The default value is: NO.
+
+EXTRACT_STATIC = NO
+
+# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
+# locally in source files will be included in the documentation. If set to NO,
+# only classes defined in header files are included. Does not have any effect
+# for Java sources.
+# The default value is: YES.
+
+EXTRACT_LOCAL_CLASSES = YES
+
+# This flag is only useful for Objective-C code. If set to YES, local methods,
+# which are defined in the implementation section but not in the interface are
+# included in the documentation. If set to NO, only methods in the interface are
+# included.
+# The default value is: NO.
+
+EXTRACT_LOCAL_METHODS = NO
+
+# If this flag is set to YES, the members of anonymous namespaces will be
+# extracted and appear in the documentation as a namespace called
+# 'anonymous_namespace{file}', where file will be replaced with the base name of
+# the file that contains the anonymous namespace. By default anonymous namespace
+# are hidden.
+# The default value is: NO.
+
+EXTRACT_ANON_NSPACES = NO
+
+# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
+# undocumented members inside documented classes or files. If set to NO these
+# members will be included in the various overviews, but no documentation
+# section is generated. This option has no effect if EXTRACT_ALL is enabled.
+# The default value is: NO.
+
+HIDE_UNDOC_MEMBERS = NO
+
+# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
+# undocumented classes that are normally visible in the class hierarchy. If set
+# to NO, these classes will be included in the various overviews. This option
+# has no effect if EXTRACT_ALL is enabled.
+# The default value is: NO.
+
+HIDE_UNDOC_CLASSES = NO
+
+# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
+# (class|struct|union) declarations. If set to NO, these declarations will be
+# included in the documentation.
+# The default value is: NO.
+
+HIDE_FRIEND_COMPOUNDS = NO
+
+# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
+# documentation blocks found inside the body of a function. If set to NO, these
+# blocks will be appended to the function's detailed documentation block.
+# The default value is: NO.
+
+HIDE_IN_BODY_DOCS = NO
+
+# The INTERNAL_DOCS tag determines if documentation that is typed after a
+# \internal command is included. If the tag is set to NO then the documentation
+# will be excluded. Set it to YES to include the internal documentation.
+# The default value is: NO.
+
+INTERNAL_DOCS = NO
+
+# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file
+# names in lower-case letters. If set to YES, upper-case letters are also
+# allowed. This is useful if you have classes or files whose names only differ
+# in case and if your file system supports case sensitive file names. Windows
+# and Mac users are advised to set this option to NO.
+# The default value is: system dependent.
+
+CASE_SENSE_NAMES = YES
+
+# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
+# their full class and namespace scopes in the documentation. If set to YES, the
+# scope will be hidden.
+# The default value is: NO.
+
+HIDE_SCOPE_NAMES = NO
+
+# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will
+# append additional text to a page's title, such as Class Reference. If set to
+# YES the compound reference will be hidden.
+# The default value is: NO.
+
+HIDE_COMPOUND_REFERENCE= NO
+
+# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
+# the files that are included by a file in the documentation of that file.
+# The default value is: YES.
+
+SHOW_INCLUDE_FILES = YES
+
+# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
+# grouped member an include statement to the documentation, telling the reader
+# which file to include in order to use the member.
+# The default value is: NO.
+
+SHOW_GROUPED_MEMB_INC = NO
+
+# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
+# files with double quotes in the documentation rather than with sharp brackets.
+# The default value is: NO.
+
+FORCE_LOCAL_INCLUDES = NO
+
+# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
+# documentation for inline members.
+# The default value is: YES.
+
+INLINE_INFO = YES
+
+# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
+# (detailed) documentation of file and class members alphabetically by member
+# name. If set to NO, the members will appear in declaration order.
+# The default value is: YES.
+
+SORT_MEMBER_DOCS = YES
+
+# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
+# descriptions of file, namespace and class members alphabetically by member
+# name. If set to NO, the members will appear in declaration order. Note that
+# this will also influence the order of the classes in the class list.
+# The default value is: NO.
+
+SORT_BRIEF_DOCS = NO
+
+# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
+# (brief and detailed) documentation of class members so that constructors and
+# destructors are listed first. If set to NO the constructors will appear in the
+# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.
+# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
+# member documentation.
+# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
+# detailed member documentation.
+# The default value is: NO.
+
+SORT_MEMBERS_CTORS_1ST = NO
+
+# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
+# of group names into alphabetical order. If set to NO the group names will
+# appear in their defined order.
+# The default value is: NO.
+
+SORT_GROUP_NAMES = NO
+
+# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
+# fully-qualified names, including namespaces. If set to NO, the class list will
+# be sorted only by class name, not including the namespace part.
+# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
+# Note: This option applies only to the class list, not to the alphabetical
+# list.
+# The default value is: NO.
+
+SORT_BY_SCOPE_NAME = YES
+
+# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
+# type resolution of all parameters of a function it will reject a match between
+# the prototype and the implementation of a member function even if there is
+# only one candidate or it is obvious which candidate to choose by doing a
+# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still
+# accept a match between prototype and implementation in such cases.
+# The default value is: NO.
+
+STRICT_PROTO_MATCHING = NO
+
+# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo
+# list. This list is created by putting \todo commands in the documentation.
+# The default value is: YES.
+
+GENERATE_TODOLIST = YES
+
+# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test
+# list. This list is created by putting \test commands in the documentation.
+# The default value is: YES.
+
+GENERATE_TESTLIST = YES
+
+# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug
+# list. This list is created by putting \bug commands in the documentation.
+# The default value is: YES.
+
+GENERATE_BUGLIST = YES
+
+# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO)
+# the deprecated list. This list is created by putting \deprecated commands in
+# the documentation.
+# The default value is: YES.
+
+GENERATE_DEPRECATEDLIST= YES
+
+# The ENABLED_SECTIONS tag can be used to enable conditional documentation
+# sections, marked by \if <section_label> ... \endif and \cond <section_label>
+# ... \endcond blocks.
+
+ENABLED_SECTIONS =
+
+# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the
+# initial value of a variable or macro / define can have for it to appear in the
+# documentation. If the initializer consists of more lines than specified here
+# it will be hidden. Use a value of 0 to hide initializers completely. The
+# appearance of the value of individual variables and macros / defines can be
+# controlled using \showinitializer or \hideinitializer command in the
+# documentation regardless of this setting.
+# Minimum value: 0, maximum value: 10000, default value: 30.
+
+MAX_INITIALIZER_LINES = 30
+
+# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
+# the bottom of the documentation of classes and structs. If set to YES, the
+# list will mention the files that were used to generate the documentation.
+# The default value is: YES.
+
+SHOW_USED_FILES = YES
+
+# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
+# will remove the Files entry from the Quick Index and from the Folder Tree View
+# (if specified).
+# The default value is: YES.
+
+SHOW_FILES = YES
+
+# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
+# page. This will remove the Namespaces entry from the Quick Index and from the
+# Folder Tree View (if specified).
+# The default value is: YES.
+
+SHOW_NAMESPACES = YES
+
+# The FILE_VERSION_FILTER tag can be used to specify a program or script that
+# doxygen should invoke to get the current version for each file (typically from
+# the version control system). Doxygen will invoke the program by executing (via
+# popen()) the command command input-file, where command is the value of the
+# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
+# by doxygen. Whatever the program writes to standard output is used as the file
+# version. For an example see the documentation.
+
+FILE_VERSION_FILTER =
+
+# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
+# by doxygen. The layout file controls the global structure of the generated
+# output files in an output format independent way. To create the layout file
+# that represents doxygen's defaults, run doxygen with the -l option. You can
+# optionally specify a file name after the option, if omitted DoxygenLayout.xml
+# will be used as the name of the layout file.
+#
+# Note that if you run doxygen from a directory containing a file called
+# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
+# tag is left empty.
+
+LAYOUT_FILE =
+
+# The CITE_BIB_FILES tag can be used to specify one or more bib files containing
+# the reference definitions. This must be a list of .bib files. The .bib
+# extension is automatically appended if omitted. This requires the bibtex tool
+# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info.
+# For LaTeX the style of the bibliography can be controlled using
+# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
+# search path. See also \cite for info how to create references.
+
+CITE_BIB_FILES =
+
+#---------------------------------------------------------------------------
+# Configuration options related to warning and progress messages
+#---------------------------------------------------------------------------
+
+# The QUIET tag can be used to turn on/off the messages that are generated to
+# standard output by doxygen. If QUIET is set to YES this implies that the
+# messages are off.
+# The default value is: NO.
+
+QUIET = NO
+
+# The WARNINGS tag can be used to turn on/off the warning messages that are
+# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES
+# this implies that the warnings are on.
+#
+# Tip: Turn warnings on while writing the documentation.
+# The default value is: YES.
+
+WARNINGS = YES
+
+# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate
+# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
+# will automatically be disabled.
+# The default value is: YES.
+
+WARN_IF_UNDOCUMENTED = YES
+
+# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
+# potential errors in the documentation, such as not documenting some parameters
+# in a documented function, or documenting parameters that don't exist or using
+# markup commands wrongly.
+# The default value is: YES.
+
+WARN_IF_DOC_ERROR = YES
+
+# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
+# are documented, but have no documentation for their parameters or return
+# value. If set to NO, doxygen will only warn about wrong or incomplete
+# parameter documentation, but not about the absence of documentation.
+# The default value is: NO.
+
+WARN_NO_PARAMDOC = NO
+
+# The WARN_FORMAT tag determines the format of the warning messages that doxygen
+# can produce. The string should contain the $file, $line, and $text tags, which
+# will be replaced by the file and line number from which the warning originated
+# and the warning text. Optionally the format may contain $version, which will
+# be replaced by the version of the file (if it could be obtained via
+# FILE_VERSION_FILTER)
+# The default value is: $file:$line: $text.
+
+WARN_FORMAT = "$file:$line: $text"
+
+# The WARN_LOGFILE tag can be used to specify a file to which warning and error
+# messages should be written. If left blank the output is written to standard
+# error (stderr).
+
+WARN_LOGFILE =
+
+#---------------------------------------------------------------------------
+# Configuration options related to the input files
+#---------------------------------------------------------------------------
+
+# The INPUT tag is used to specify the files and/or directories that contain
+# documented source files. You may enter file names like myfile.cpp or
+# directories like /usr/src/myproject. Separate the files or directories with
+# spaces.
+# Note: If this tag is empty the current directory is searched.
+
+INPUT = lib
+
+# This tag can be used to specify the character encoding of the source files
+# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
+# libiconv (or the iconv built into libc) for the transcoding. See the libiconv
+# documentation (see: http://www.gnu.org/software/libiconv) for the list of
+# possible encodings.
+# The default value is: UTF-8.
+
+INPUT_ENCODING = UTF-8
+
+# If the value of the INPUT tag contains directories, you can use the
+# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
+# *.h) to filter out the source-files in the directories. If left blank the
+# following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii,
+# *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp,
+# *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown,
+# *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf,
+# *.qsf, *.as and *.js.
+
+FILE_PATTERNS = *.pm \
+ *.pl
+
+# The RECURSIVE tag can be used to specify whether or not subdirectories should
+# be searched for input files as well.
+# The default value is: NO.
+
+RECURSIVE = YES
+
+# The EXCLUDE tag can be used to specify files and/or directories that should be
+# excluded from the INPUT source files. This way you can easily exclude a
+# subdirectory from a directory tree whose root is specified with the INPUT tag.
+#
+# Note that relative paths are relative to the directory from which doxygen is
+# run.
+
+EXCLUDE =
+
+# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
+# directories that are symbolic links (a Unix file system feature) are excluded
+# from the input.
+# The default value is: NO.
+
+EXCLUDE_SYMLINKS = NO
+
+# If the value of the INPUT tag contains directories, you can use the
+# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
+# certain files from those directories.
+#
+# Note that the wildcards are matched against the file with absolute path, so to
+# exclude all test directories for example use the pattern */test/*
+
+EXCLUDE_PATTERNS =
+
+# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
+# (namespaces, classes, functions, etc.) that should be excluded from the
+# output. The symbol name can be a fully qualified name, a word, or if the
+# wildcard * is used, a substring. Examples: ANamespace, AClass,
+# AClass::ANamespace, ANamespace::*Test
+#
+# Note that the wildcards are matched against the file with absolute path, so to
+# exclude all test directories use the pattern */test/*
+
+EXCLUDE_SYMBOLS =
+
+# The EXAMPLE_PATH tag can be used to specify one or more files or directories
+# that contain example code fragments that are included (see the \include
+# command).
+
+EXAMPLE_PATH =
+
+# If the value of the EXAMPLE_PATH tag contains directories, you can use the
+# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
+# *.h) to filter out the source-files in the directories. If left blank all
+# files are included.
+
+EXAMPLE_PATTERNS =
+
+# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
+# searched for input files to be used with the \include or \dontinclude commands
+# irrespective of the value of the RECURSIVE tag.
+# The default value is: NO.
+
+EXAMPLE_RECURSIVE = YES
+
+# The IMAGE_PATH tag can be used to specify one or more files or directories
+# that contain images that are to be included in the documentation (see the
+# \image command).
+
+IMAGE_PATH =
+
+# The INPUT_FILTER tag can be used to specify a program that doxygen should
+# invoke to filter for each input file. Doxygen will invoke the filter program
+# by executing (via popen()) the command:
+#
+# <filter> <input-file>
+#
+# where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
+# name of an input file. Doxygen will then use the output that the filter
+# program writes to standard output. If FILTER_PATTERNS is specified, this tag
+# will be ignored.
+#
+# Note that the filter must not add or remove lines; it is applied before the
+# code is scanned, but not when the output code is generated. If lines are added
+# or removed, the anchors will not be placed correctly.
+
+INPUT_FILTER = doxygen-filter-perl
+
+# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
+# basis. Doxygen will compare the file name with each pattern and apply the
+# filter if there is a match. The filters are a list of the form: pattern=filter
+# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
+# filters are used. If the FILTER_PATTERNS tag is empty or if none of the
+# patterns match the file name, INPUT_FILTER is applied.
+
+FILTER_PATTERNS =
+
+# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
+# INPUT_FILTER) will also be used to filter the input files that are used for
+# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
+# The default value is: NO.
+
+FILTER_SOURCE_FILES = NO
+
+# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
+# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
+# it is also possible to disable source filtering for a specific pattern using
+# *.ext= (so without naming a filter).
+# This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
+
+FILTER_SOURCE_PATTERNS =
+
+# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
+# is part of the input, its contents will be placed on the main page
+# (index.html). This can be useful if you have a project on for instance GitHub
+# and want to reuse the introduction page also for the doxygen output.
+
+USE_MDFILE_AS_MAINPAGE =
+
+#---------------------------------------------------------------------------
+# Configuration options related to source browsing
+#---------------------------------------------------------------------------
+
+# If the SOURCE_BROWSER tag is set to YES then a list of source files will be
+# generated. Documented entities will be cross-referenced with these sources.
+#
+# Note: To get rid of all source code in the generated output, make sure that
+# also VERBATIM_HEADERS is set to NO.
+# The default value is: NO.
+
+SOURCE_BROWSER = YES
+
+# Setting the INLINE_SOURCES tag to YES will include the body of functions,
+# classes and enums directly into the documentation.
+# The default value is: NO.
+
+INLINE_SOURCES = NO
+
+# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
+# special comment blocks from generated source code fragments. Normal C, C++ and
+# Fortran comments will always remain visible.
+# The default value is: YES.
+
+STRIP_CODE_COMMENTS = YES
+
+# If the REFERENCED_BY_RELATION tag is set to YES then for each documented
+# function all documented functions referencing it will be listed.
+# The default value is: NO.
+
+REFERENCED_BY_RELATION = YES
+
+# If the REFERENCES_RELATION tag is set to YES then for each documented function
+# all documented entities called/used by that function will be listed.
+# The default value is: NO.
+
+REFERENCES_RELATION = YES
+
+# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
+# to YES then the hyperlinks from functions in REFERENCES_RELATION and
+# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
+# link to the documentation.
+# The default value is: YES.
+
+REFERENCES_LINK_SOURCE = YES
+
+# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
+# source code will show a tooltip with additional information such as prototype,
+# brief description and links to the definition and documentation. Since this
+# will make the HTML file larger and loading of large files a bit slower, you
+# can opt to disable this feature.
+# The default value is: YES.
+# This tag requires that the tag SOURCE_BROWSER is set to YES.
+
+SOURCE_TOOLTIPS = YES
+
+# If the USE_HTAGS tag is set to YES then the references to source code will
+# point to the HTML generated by the htags(1) tool instead of doxygen built-in
+# source browser. The htags tool is part of GNU's global source tagging system
+# (see http://www.gnu.org/software/global/global.html). You will need version
+# 4.8.6 or higher.
+#
+# To use it do the following:
+# - Install the latest version of global
+# - Enable SOURCE_BROWSER and USE_HTAGS in the config file
+# - Make sure the INPUT points to the root of the source tree
+# - Run doxygen as normal
+#
+# Doxygen will invoke htags (and that will in turn invoke gtags), so these
+# tools must be available from the command line (i.e. in the search path).
+#
+# The result: instead of the source browser generated by doxygen, the links to
+# source code will now point to the output of htags.
+# The default value is: NO.
+# This tag requires that the tag SOURCE_BROWSER is set to YES.
+
+USE_HTAGS = NO
+
+# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
+# verbatim copy of the header file for each class for which an include is
+# specified. Set to NO to disable this.
+# See also: Section \class.
+# The default value is: YES.
+
+VERBATIM_HEADERS = NO
+
+# If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the
+# clang parser (see: http://clang.llvm.org/) for more accurate parsing at the
+# cost of reduced performance. This can be particularly helpful with template
+# rich C++ code for which doxygen's built-in parser lacks the necessary type
+# information.
+# Note: The availability of this option depends on whether or not doxygen was
+# compiled with the --with-libclang option.
+# The default value is: NO.
+
+CLANG_ASSISTED_PARSING = NO
+
+# If clang assisted parsing is enabled you can provide the compiler with command
+# line options that you would normally use when invoking the compiler. Note that
+# the include paths will already be set by doxygen for the files and directories
+# specified with INPUT and INCLUDE_PATH.
+# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES.
+
+CLANG_OPTIONS =
+
+#---------------------------------------------------------------------------
+# Configuration options related to the alphabetical class index
+#---------------------------------------------------------------------------
+
+# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
+# compounds will be generated. Enable this if the project contains a lot of
+# classes, structs, unions or interfaces.
+# The default value is: YES.
+
+ALPHABETICAL_INDEX = YES
+
+# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
+# which the alphabetical index list will be split.
+# Minimum value: 1, maximum value: 20, default value: 5.
+# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
+
+COLS_IN_ALPHA_INDEX = 5
+
+# In case all classes in a project start with a common prefix, all classes will
+# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
+# can be used to specify a prefix (or a list of prefixes) that should be ignored
+# while generating the index headers.
+# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
+
+IGNORE_PREFIX =
+
+#---------------------------------------------------------------------------
+# Configuration options related to the HTML output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
+# The default value is: YES.
+
+GENERATE_HTML = YES
+
+# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
+# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
+# it.
+# The default directory is: html.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_OUTPUT = html
+
+# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
+# generated HTML page (for example: .htm, .php, .asp).
+# The default value is: .html.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_FILE_EXTENSION = .html
+
+# The HTML_HEADER tag can be used to specify a user-defined HTML header file for
+# each generated HTML page. If the tag is left blank doxygen will generate a
+# standard header.
+#
+# To get valid HTML the header file that includes any scripts and style sheets
+# that doxygen needs, which is dependent on the configuration options used (e.g.
+# the setting GENERATE_TREEVIEW). It is highly recommended to start with a
+# default header using
+# doxygen -w html new_header.html new_footer.html new_stylesheet.css
+# YourConfigFile
+# and then modify the file new_header.html. See also section "Doxygen usage"
+# for information on how to generate the default header that doxygen normally
+# uses.
+# Note: The header is subject to change so you typically have to regenerate the
+# default header when upgrading to a newer version of doxygen. For a description
+# of the possible markers and block names see the documentation.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_HEADER =
+
+# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
+# generated HTML page. If the tag is left blank doxygen will generate a standard
+# footer. See HTML_HEADER for more information on how to generate a default
+# footer and what special commands can be used inside the footer. See also
+# section "Doxygen usage" for information on how to generate the default footer
+# that doxygen normally uses.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_FOOTER =
+
+# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
+# sheet that is used by each HTML page. It can be used to fine-tune the look of
+# the HTML output. If left blank doxygen will generate a default style sheet.
+# See also section "Doxygen usage" for information on how to generate the style
+# sheet that doxygen normally uses.
+# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
+# it is more robust and this tag (HTML_STYLESHEET) will in the future become
+# obsolete.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_STYLESHEET =
+
+# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
+# cascading style sheets that are included after the standard style sheets
+# created by doxygen. Using this option one can overrule certain style aspects.
+# This is preferred over using HTML_STYLESHEET since it does not replace the
+# standard style sheet and is therefore more robust against future updates.
+# Doxygen will copy the style sheet files to the output directory.
+# Note: The order of the extra style sheet files is of importance (e.g. the last
+# style sheet in the list overrules the setting of the previous ones in the
+# list). For an example see the documentation.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_EXTRA_STYLESHEET =
+
+# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
+# other source files which should be copied to the HTML output directory. Note
+# that these files will be copied to the base HTML output directory. Use the
+# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
+# files. In the HTML_STYLESHEET file, use the file name only. Also note that the
+# files will be copied as-is; there are no commands or markers available.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_EXTRA_FILES =
+
+# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
+# will adjust the colors in the style sheet and background images according to
+# this color. Hue is specified as an angle on a colorwheel, see
+# http://en.wikipedia.org/wiki/Hue for more information. For instance the value
+# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
+# purple, and 360 is red again.
+# Minimum value: 0, maximum value: 359, default value: 220.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_COLORSTYLE_HUE = 220
+
+# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
+# in the HTML output. For a value of 0 the output will use grayscales only. A
+# value of 255 will produce the most vivid colors.
+# Minimum value: 0, maximum value: 255, default value: 100.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_COLORSTYLE_SAT = 100
+
+# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
+# luminance component of the colors in the HTML output. Values below 100
+# gradually make the output lighter, whereas values above 100 make the output
+# darker. The value divided by 100 is the actual gamma applied, so 80 represents
+# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
+# change the gamma.
+# Minimum value: 40, maximum value: 240, default value: 80.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_COLORSTYLE_GAMMA = 80
+
+# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
+# page will contain the date and time when the page was generated. Setting this
+# to NO can help when comparing the output of multiple runs.
+# The default value is: YES.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_TIMESTAMP = YES
+
+# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
+# documentation will contain sections that can be hidden and shown after the
+# page has loaded.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_DYNAMIC_SECTIONS = YES
+
+# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
+# shown in the various tree structured indices initially; the user can expand
+# and collapse entries dynamically later on. Doxygen will expand the tree to
+# such a level that at most the specified number of entries are visible (unless
+# a fully collapsed tree already exceeds this amount). So setting the number of
+# entries 1 will produce a full collapsed tree by default. 0 is a special value
+# representing an infinite number of entries and will result in a full expanded
+# tree by default.
+# Minimum value: 0, maximum value: 9999, default value: 100.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_INDEX_NUM_ENTRIES = 100
+
+# If the GENERATE_DOCSET tag is set to YES, additional index files will be
+# generated that can be used as input for Apple's Xcode 3 integrated development
+# environment (see: http://developer.apple.com/tools/xcode/), introduced with
+# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a
+# Makefile in the HTML output directory. Running make will produce the docset in
+# that directory and running make install will install the docset in
+# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
+# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
+# for more information.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+GENERATE_DOCSET = NO
+
+# This tag determines the name of the docset feed. A documentation feed provides
+# an umbrella under which multiple documentation sets from a single provider
+# (such as a company or product suite) can be grouped.
+# The default value is: Doxygen generated docs.
+# This tag requires that the tag GENERATE_DOCSET is set to YES.
+
+DOCSET_FEEDNAME = "Doxygen generated docs"
+
+# This tag specifies a string that should uniquely identify the documentation
+# set bundle. This should be a reverse domain-name style string, e.g.
+# com.mycompany.MyDocSet. Doxygen will append .docset to the name.
+# The default value is: org.doxygen.Project.
+# This tag requires that the tag GENERATE_DOCSET is set to YES.
+
+DOCSET_BUNDLE_ID = org.doxygen.Project
+
+# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
+# the documentation publisher. This should be a reverse domain-name style
+# string, e.g. com.mycompany.MyDocSet.documentation.
+# The default value is: org.doxygen.Publisher.
+# This tag requires that the tag GENERATE_DOCSET is set to YES.
+
+DOCSET_PUBLISHER_ID = org.doxygen.Publisher
+
+# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
+# The default value is: Publisher.
+# This tag requires that the tag GENERATE_DOCSET is set to YES.
+
+DOCSET_PUBLISHER_NAME = Publisher
+
+# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
+# additional HTML index files: index.hhp, index.hhc, and index.hhk. The
+# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
+# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on
+# Windows.
+#
+# The HTML Help Workshop contains a compiler that can convert all HTML output
+# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
+# files are now used as the Windows 98 help format, and will replace the old
+# Windows help format (.hlp) on all Windows platforms in the future. Compressed
+# HTML files also contain an index, a table of contents, and you can search for
+# words in the documentation. The HTML workshop also contains a viewer for
+# compressed HTML files.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+GENERATE_HTMLHELP = NO
+
+# The CHM_FILE tag can be used to specify the file name of the resulting .chm
+# file. You can add a path in front of the file if the result should not be
+# written to the html output directory.
+# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
+
+CHM_FILE =
+
+# The HHC_LOCATION tag can be used to specify the location (absolute path
+# including file name) of the HTML help compiler (hhc.exe). If non-empty,
+# doxygen will try to run the HTML help compiler on the generated index.hhp.
+# The file has to be specified with full path.
+# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
+
+HHC_LOCATION =
+
+# The GENERATE_CHI flag controls if a separate .chi index file is generated
+# (YES) or that it should be included in the master .chm file (NO).
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
+
+GENERATE_CHI = NO
+
+# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc)
+# and project file content.
+# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
+
+CHM_INDEX_ENCODING =
+
+# The BINARY_TOC flag controls whether a binary table of contents is generated
+# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it
+# enables the Previous and Next buttons.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
+
+BINARY_TOC = NO
+
+# The TOC_EXPAND flag can be set to YES to add extra items for group members to
+# the table of contents of the HTML help documentation and to the tree view.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
+
+TOC_EXPAND = NO
+
+# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
+# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
+# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
+# (.qch) of the generated HTML documentation.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+GENERATE_QHP = NO
+
+# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
+# the file name of the resulting .qch file. The path specified is relative to
+# the HTML output folder.
+# This tag requires that the tag GENERATE_QHP is set to YES.
+
+QCH_FILE =
+
+# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
+# Project output. For more information please see Qt Help Project / Namespace
+# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace).
+# The default value is: org.doxygen.Project.
+# This tag requires that the tag GENERATE_QHP is set to YES.
+
+QHP_NAMESPACE = org.doxygen.Project
+
+# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
+# Help Project output. For more information please see Qt Help Project / Virtual
+# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual-
+# folders).
+# The default value is: doc.
+# This tag requires that the tag GENERATE_QHP is set to YES.
+
+QHP_VIRTUAL_FOLDER = doc
+
+# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
+# filter to add. For more information please see Qt Help Project / Custom
+# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
+# filters).
+# This tag requires that the tag GENERATE_QHP is set to YES.
+
+QHP_CUST_FILTER_NAME =
+
+# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
+# custom filter to add. For more information please see Qt Help Project / Custom
+# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
+# filters).
+# This tag requires that the tag GENERATE_QHP is set to YES.
+
+QHP_CUST_FILTER_ATTRS =
+
+# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
+# project's filter section matches. Qt Help Project / Filter Attributes (see:
+# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes).
+# This tag requires that the tag GENERATE_QHP is set to YES.
+
+QHP_SECT_FILTER_ATTRS =
+
+# The QHG_LOCATION tag can be used to specify the location of Qt's
+# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
+# generated .qhp file.
+# This tag requires that the tag GENERATE_QHP is set to YES.
+
+QHG_LOCATION =
+
+# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
+# generated, together with the HTML files, they form an Eclipse help plugin. To
+# install this plugin and make it available under the help contents menu in
+# Eclipse, the contents of the directory containing the HTML and XML files needs
+# to be copied into the plugins directory of eclipse. The name of the directory
+# within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
+# After copying Eclipse needs to be restarted before the help appears.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+GENERATE_ECLIPSEHELP = NO
+
+# A unique identifier for the Eclipse help plugin. When installing the plugin
+# the directory name containing the HTML and XML files should also have this
+# name. Each documentation set should have its own identifier.
+# The default value is: org.doxygen.Project.
+# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
+
+ECLIPSE_DOC_ID = org.doxygen.Project
+
+# If you want full control over the layout of the generated HTML pages it might
+# be necessary to disable the index and replace it with your own. The
+# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
+# of each HTML page. A value of NO enables the index and the value YES disables
+# it. Since the tabs in the index contain the same information as the navigation
+# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+DISABLE_INDEX = NO
+
+# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
+# structure should be generated to display hierarchical information. If the tag
+# value is set to YES, a side panel will be generated containing a tree-like
+# index structure (just like the one that is generated for HTML Help). For this
+# to work a browser that supports JavaScript, DHTML, CSS and frames is required
+# (i.e. any modern browser). Windows users are probably better off using the
+# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can
+# further fine-tune the look of the index. As an example, the default style
+# sheet generated by doxygen has an example that shows how to put an image at
+# the root of the tree instead of the PROJECT_NAME. Since the tree basically has
+# the same information as the tab index, you could consider setting
+# DISABLE_INDEX to YES when enabling this option.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+GENERATE_TREEVIEW = YES
+
+# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
+# doxygen will group on one line in the generated HTML documentation.
+#
+# Note that a value of 0 will completely suppress the enum values from appearing
+# in the overview section.
+# Minimum value: 0, maximum value: 20, default value: 4.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+ENUM_VALUES_PER_LINE = 4
+
+# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
+# to set the initial width (in pixels) of the frame in which the tree is shown.
+# Minimum value: 0, maximum value: 1500, default value: 250.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+TREEVIEW_WIDTH = 250
+
+# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to
+# external symbols imported via tag files in a separate window.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+EXT_LINKS_IN_WINDOW = NO
+
+# Use this tag to change the font size of LaTeX formulas included as images in
+# the HTML documentation. When you change the font size after a successful
+# doxygen run you need to manually remove any form_*.png images from the HTML
+# output directory to force them to be regenerated.
+# Minimum value: 8, maximum value: 50, default value: 10.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+FORMULA_FONTSIZE = 10
+
+# Use the FORMULA_TRANPARENT tag to determine whether or not the images
+# generated for formulas are transparent PNGs. Transparent PNGs are not
+# supported properly for IE 6.0, but are supported on all modern browsers.
+#
+# Note that when changing this option you need to delete any form_*.png files in
+# the HTML output directory before the changes have effect.
+# The default value is: YES.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+FORMULA_TRANSPARENT = YES
+
+# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
+# http://www.mathjax.org) which uses client side Javascript for the rendering
+# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX
+# installed or if you want to formulas look prettier in the HTML output. When
+# enabled you may also need to install MathJax separately and configure the path
+# to it using the MATHJAX_RELPATH option.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+USE_MATHJAX = NO
+
+# When MathJax is enabled you can set the default output format to be used for
+# the MathJax output. See the MathJax site (see:
+# http://docs.mathjax.org/en/latest/output.html) for more details.
+# Possible values are: HTML-CSS (which is slower, but has the best
+# compatibility), NativeMML (i.e. MathML) and SVG.
+# The default value is: HTML-CSS.
+# This tag requires that the tag USE_MATHJAX is set to YES.
+
+MATHJAX_FORMAT = HTML-CSS
+
+# When MathJax is enabled you need to specify the location relative to the HTML
+# output directory using the MATHJAX_RELPATH option. The destination directory
+# should contain the MathJax.js script. For instance, if the mathjax directory
+# is located at the same level as the HTML output directory, then
+# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
+# Content Delivery Network so you can quickly see the result without installing
+# MathJax. However, it is strongly recommended to install a local copy of
+# MathJax from http://www.mathjax.org before deployment.
+# The default value is: http://cdn.mathjax.org/mathjax/latest.
+# This tag requires that the tag USE_MATHJAX is set to YES.
+
+MATHJAX_RELPATH = http://www.mathjax.org/mathjax
+
+# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
+# extension names that should be enabled during MathJax rendering. For example
+# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
+# This tag requires that the tag USE_MATHJAX is set to YES.
+
+MATHJAX_EXTENSIONS =
+
+# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
+# of code that will be used on startup of the MathJax code. See the MathJax site
+# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an
+# example see the documentation.
+# This tag requires that the tag USE_MATHJAX is set to YES.
+
+MATHJAX_CODEFILE =
+
+# When the SEARCHENGINE tag is enabled doxygen will generate a search box for
+# the HTML output. The underlying search engine uses javascript and DHTML and
+# should work on any modern browser. Note that when using HTML help
+# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)
+# there is already a search function so this one should typically be disabled.
+# For large projects the javascript based search engine can be slow, then
+# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
+# search using the keyboard; to jump to the search box use <access key> + S
+# (what the <access key> is depends on the OS and browser, but it is typically
+# <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down
+# key> to jump into the search results window, the results can be navigated
+# using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
+# the search. The filter options can be selected when the cursor is inside the
+# search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>
+# to select a filter and <Enter> or <escape> to activate or cancel the filter
+# option.
+# The default value is: YES.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+SEARCHENGINE = NO
+
+# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
+# implemented using a web server instead of a web client using Javascript. There
+# are two flavors of web server based searching depending on the EXTERNAL_SEARCH
+# setting. When disabled, doxygen will generate a PHP script for searching and
+# an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing
+# and searching needs to be provided by external tools. See the section
+# "External Indexing and Searching" for details.
+# The default value is: NO.
+# This tag requires that the tag SEARCHENGINE is set to YES.
+
+SERVER_BASED_SEARCH = NO
+
+# When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
+# script for searching. Instead the search results are written to an XML file
+# which needs to be processed by an external indexer. Doxygen will invoke an
+# external search engine pointed to by the SEARCHENGINE_URL option to obtain the
+# search results.
+#
+# Doxygen ships with an example indexer (doxyindexer) and search engine
+# (doxysearch.cgi) which are based on the open source search engine library
+# Xapian (see: http://xapian.org/).
+#
+# See the section "External Indexing and Searching" for details.
+# The default value is: NO.
+# This tag requires that the tag SEARCHENGINE is set to YES.
+
+EXTERNAL_SEARCH = NO
+
+# The SEARCHENGINE_URL should point to a search engine hosted by a web server
+# which will return the search results when EXTERNAL_SEARCH is enabled.
+#
+# Doxygen ships with an example indexer (doxyindexer) and search engine
+# (doxysearch.cgi) which are based on the open source search engine library
+# Xapian (see: http://xapian.org/). See the section "External Indexing and
+# Searching" for details.
+# This tag requires that the tag SEARCHENGINE is set to YES.
+
+SEARCHENGINE_URL =
+
+# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
+# search data is written to a file for indexing by an external tool. With the
+# SEARCHDATA_FILE tag the name of this file can be specified.
+# The default file is: searchdata.xml.
+# This tag requires that the tag SEARCHENGINE is set to YES.
+
+SEARCHDATA_FILE = searchdata.xml
+
+# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
+# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
+# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
+# projects and redirect the results back to the right project.
+# This tag requires that the tag SEARCHENGINE is set to YES.
+
+EXTERNAL_SEARCH_ID =
+
+# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
+# projects other than the one defined by this configuration file, but that are
+# all added to the same external search index. Each project needs to have a
+# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
+# to a relative location where the documentation can be found. The format is:
+# EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
+# This tag requires that the tag SEARCHENGINE is set to YES.
+
+EXTRA_SEARCH_MAPPINGS =
+
+#---------------------------------------------------------------------------
+# Configuration options related to the LaTeX output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
+# The default value is: YES.
+
+GENERATE_LATEX = NO
+
+# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
+# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
+# it.
+# The default directory is: latex.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+LATEX_OUTPUT = latex
+
+# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
+# invoked.
+#
+# Note that when enabling USE_PDFLATEX this option is only used for generating
+# bitmaps for formulas in the HTML output, but not in the Makefile that is
+# written to the output directory.
+# The default file is: latex.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+LATEX_CMD_NAME = latex
+
+# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
+# index for LaTeX.
+# The default file is: makeindex.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+MAKEINDEX_CMD_NAME = makeindex
+
+# If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX
+# documents. This may be useful for small projects and may help to save some
+# trees in general.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+COMPACT_LATEX = NO
+
+# The PAPER_TYPE tag can be used to set the paper type that is used by the
+# printer.
+# Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x
+# 14 inches) and executive (7.25 x 10.5 inches).
+# The default value is: a4.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+PAPER_TYPE = a4wide
+
+# The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
+# that should be included in the LaTeX output. To get the times font for
+# instance you can specify
+# EXTRA_PACKAGES=times
+# If left blank no extra packages will be included.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+EXTRA_PACKAGES =
+
+# The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
+# generated LaTeX document. The header should contain everything until the first
+# chapter. If it is left blank doxygen will generate a standard header. See
+# section "Doxygen usage" for information on how to let doxygen write the
+# default header to a separate file.
+#
+# Note: Only use a user-defined header if you know what you are doing! The
+# following commands have a special meaning inside the header: $title,
+# $datetime, $date, $doxygenversion, $projectname, $projectnumber,
+# $projectbrief, $projectlogo. Doxygen will replace $title with the empty
+# string, for the replacement values of the other commands the user is referred
+# to HTML_HEADER.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+LATEX_HEADER =
+
+# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
+# generated LaTeX document. The footer should contain everything after the last
+# chapter. If it is left blank doxygen will generate a standard footer. See
+# LATEX_HEADER for more information on how to generate a default footer and what
+# special commands can be used inside the footer.
+#
+# Note: Only use a user-defined footer if you know what you are doing!
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+LATEX_FOOTER =
+
+# The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined
+# LaTeX style sheets that are included after the standard style sheets created
+# by doxygen. Using this option one can overrule certain style aspects. Doxygen
+# will copy the style sheet files to the output directory.
+# Note: The order of the extra style sheet files is of importance (e.g. the last
+# style sheet in the list overrules the setting of the previous ones in the
+# list).
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+LATEX_EXTRA_STYLESHEET =
+
+# The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
+# other source files which should be copied to the LATEX_OUTPUT output
+# directory. Note that the files will be copied as-is; there are no commands or
+# markers available.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+LATEX_EXTRA_FILES =
+
+# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
+# prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
+# contain links (just like the HTML output) instead of page references. This
+# makes the output suitable for online browsing using a PDF viewer.
+# The default value is: YES.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+PDF_HYPERLINKS = NO
+
+# If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
+# the PDF file directly from the LaTeX files. Set this option to YES, to get a
+# higher quality PDF documentation.
+# The default value is: YES.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+USE_PDFLATEX = YES
+
+# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
+# command to the generated LaTeX files. This will instruct LaTeX to keep running
+# if errors occur, instead of asking the user for help. This option is also used
+# when generating formulas in HTML.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+LATEX_BATCHMODE = NO
+
+# If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
+# index chapters (such as File Index, Compound Index, etc.) in the output.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+LATEX_HIDE_INDICES = NO
+
+# If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
+# code with syntax highlighting in the LaTeX output.
+#
+# Note that which sources are shown also depends on other settings such as
+# SOURCE_BROWSER.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+LATEX_SOURCE_CODE = NO
+
+# The LATEX_BIB_STYLE tag can be used to specify the style to use for the
+# bibliography, e.g. plainnat, or ieeetr. See
+# http://en.wikipedia.org/wiki/BibTeX and \cite for more info.
+# The default value is: plain.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+LATEX_BIB_STYLE = plain
+
+#---------------------------------------------------------------------------
+# Configuration options related to the RTF output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The
+# RTF output is optimized for Word 97 and may not look too pretty with other RTF
+# readers/editors.
+# The default value is: NO.
+
+GENERATE_RTF = NO
+
+# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
+# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
+# it.
+# The default directory is: rtf.
+# This tag requires that the tag GENERATE_RTF is set to YES.
+
+RTF_OUTPUT = rtf
+
+# If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF
+# documents. This may be useful for small projects and may help to save some
+# trees in general.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_RTF is set to YES.
+
+COMPACT_RTF = NO
+
+# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
+# contain hyperlink fields. The RTF file will contain links (just like the HTML
+# output) instead of page references. This makes the output suitable for online
+# browsing using Word or some other Word compatible readers that support those
+# fields.
+#
+# Note: WordPad (write) and others do not support links.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_RTF is set to YES.
+
+RTF_HYPERLINKS = NO
+
+# Load stylesheet definitions from file. Syntax is similar to doxygen's config
+# file, i.e. a series of assignments. You only have to provide replacements,
+# missing definitions are set to their default value.
+#
+# See also section "Doxygen usage" for information on how to generate the
+# default style sheet that doxygen normally uses.
+# This tag requires that the tag GENERATE_RTF is set to YES.
+
+RTF_STYLESHEET_FILE =
+
+# Set optional variables used in the generation of an RTF document. Syntax is
+# similar to doxygen's config file. A template extensions file can be generated
+# using doxygen -e rtf extensionFile.
+# This tag requires that the tag GENERATE_RTF is set to YES.
+
+RTF_EXTENSIONS_FILE =
+
+# If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code
+# with syntax highlighting in the RTF output.
+#
+# Note that which sources are shown also depends on other settings such as
+# SOURCE_BROWSER.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_RTF is set to YES.
+
+RTF_SOURCE_CODE = NO
+
+#---------------------------------------------------------------------------
+# Configuration options related to the man page output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for
+# classes and files.
+# The default value is: NO.
+
+GENERATE_MAN = NO
+
+# The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
+# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
+# it. A directory man3 will be created inside the directory specified by
+# MAN_OUTPUT.
+# The default directory is: man.
+# This tag requires that the tag GENERATE_MAN is set to YES.
+
+MAN_OUTPUT = man
+
+# The MAN_EXTENSION tag determines the extension that is added to the generated
+# man pages. In case the manual section does not start with a number, the number
+# 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
+# optional.
+# The default value is: .3.
+# This tag requires that the tag GENERATE_MAN is set to YES.
+
+MAN_EXTENSION = .3
+
+# The MAN_SUBDIR tag determines the name of the directory created within
+# MAN_OUTPUT in which the man pages are placed. If defaults to man followed by
+# MAN_EXTENSION with the initial . removed.
+# This tag requires that the tag GENERATE_MAN is set to YES.
+
+MAN_SUBDIR =
+
+# If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
+# will generate one additional man file for each entity documented in the real
+# man page(s). These additional files only source the real man page, but without
+# them the man command would be unable to find the correct page.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_MAN is set to YES.
+
+MAN_LINKS = NO
+
+#---------------------------------------------------------------------------
+# Configuration options related to the XML output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that
+# captures the structure of the code including all documentation.
+# The default value is: NO.
+
+GENERATE_XML = NO
+
+# The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
+# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
+# it.
+# The default directory is: xml.
+# This tag requires that the tag GENERATE_XML is set to YES.
+
+XML_OUTPUT = xml
+
+# If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program
+# listings (including syntax highlighting and cross-referencing information) to
+# the XML output. Note that enabling this will significantly increase the size
+# of the XML output.
+# The default value is: YES.
+# This tag requires that the tag GENERATE_XML is set to YES.
+
+XML_PROGRAMLISTING = YES
+
+#---------------------------------------------------------------------------
+# Configuration options related to the DOCBOOK output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files
+# that can be used to generate PDF.
+# The default value is: NO.
+
+GENERATE_DOCBOOK = NO
+
+# The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
+# front of it.
+# The default directory is: docbook.
+# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
+
+DOCBOOK_OUTPUT = docbook
+
+# If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the
+# program listings (including syntax highlighting and cross-referencing
+# information) to the DOCBOOK output. Note that enabling this will significantly
+# increase the size of the DOCBOOK output.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
+
+DOCBOOK_PROGRAMLISTING = NO
+
+#---------------------------------------------------------------------------
+# Configuration options for the AutoGen Definitions output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an
+# AutoGen Definitions (see http://autogen.sf.net) file that captures the
+# structure of the code including all documentation. Note that this feature is
+# still experimental and incomplete at the moment.
+# The default value is: NO.
+
+GENERATE_AUTOGEN_DEF = NO
+
+#---------------------------------------------------------------------------
+# Configuration options related to the Perl module output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module
+# file that captures the structure of the code including all documentation.
+#
+# Note that this feature is still experimental and incomplete at the moment.
+# The default value is: NO.
+
+GENERATE_PERLMOD = NO
+
+# If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary
+# Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
+# output from the Perl module output.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_PERLMOD is set to YES.
+
+PERLMOD_LATEX = NO
+
+# If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely
+# formatted so it can be parsed by a human reader. This is useful if you want to
+# understand what is going on. On the other hand, if this tag is set to NO, the
+# size of the Perl module output will be much smaller and Perl will parse it
+# just the same.
+# The default value is: YES.
+# This tag requires that the tag GENERATE_PERLMOD is set to YES.
+
+PERLMOD_PRETTY = YES
+
+# The names of the make variables in the generated doxyrules.make file are
+# prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
+# so different doxyrules.make files included by the same Makefile don't
+# overwrite each other's variables.
+# This tag requires that the tag GENERATE_PERLMOD is set to YES.
+
+PERLMOD_MAKEVAR_PREFIX =
+
+#---------------------------------------------------------------------------
+# Configuration options related to the preprocessor
+#---------------------------------------------------------------------------
+
+# If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all
+# C-preprocessor directives found in the sources and include files.
+# The default value is: YES.
+
+ENABLE_PREPROCESSING = NO
+
+# If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names
+# in the source code. If set to NO, only conditional compilation will be
+# performed. Macro expansion can be done in a controlled way by setting
+# EXPAND_ONLY_PREDEF to YES.
+# The default value is: NO.
+# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
+
+MACRO_EXPANSION = NO
+
+# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
+# the macro expansion is limited to the macros specified with the PREDEFINED and
+# EXPAND_AS_DEFINED tags.
+# The default value is: NO.
+# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
+
+EXPAND_ONLY_PREDEF = NO
+
+# If the SEARCH_INCLUDES tag is set to YES, the include files in the
+# INCLUDE_PATH will be searched if a #include is found.
+# The default value is: YES.
+# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
+
+SEARCH_INCLUDES = NO
+
+# The INCLUDE_PATH tag can be used to specify one or more directories that
+# contain include files that are not input files but should be processed by the
+# preprocessor.
+# This tag requires that the tag SEARCH_INCLUDES is set to YES.
+
+INCLUDE_PATH =
+
+# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
+# patterns (like *.h and *.hpp) to filter out the header-files in the
+# directories. If left blank, the patterns specified with FILE_PATTERNS will be
+# used.
+# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
+
+INCLUDE_FILE_PATTERNS =
+
+# The PREDEFINED tag can be used to specify one or more macro names that are
+# defined before the preprocessor is started (similar to the -D option of e.g.
+# gcc). The argument of the tag is a list of macros of the form: name or
+# name=definition (no spaces). If the definition and the "=" are omitted, "=1"
+# is assumed. To prevent a macro definition from being undefined via #undef or
+# recursively expanded use the := operator instead of the = operator.
+# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
+
+PREDEFINED =
+
+# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
+# tag can be used to specify a list of macro names that should be expanded. The
+# macro definition that is found in the sources will be used. Use the PREDEFINED
+# tag if you want to use a different macro definition that overrules the
+# definition found in the source code.
+# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
+
+EXPAND_AS_DEFINED =
+
+# If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
+# remove all references to function-like macros that are alone on a line, have
+# an all uppercase name, and do not end with a semicolon. Such function macros
+# are typically used for boiler-plate code, and will confuse the parser if not
+# removed.
+# The default value is: YES.
+# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
+
+SKIP_FUNCTION_MACROS = YES
+
+#---------------------------------------------------------------------------
+# Configuration options related to external references
+#---------------------------------------------------------------------------
+
+# The TAGFILES tag can be used to specify one or more tag files. For each tag
+# file the location of the external documentation should be added. The format of
+# a tag file without this location is as follows:
+# TAGFILES = file1 file2 ...
+# Adding location for the tag files is done as follows:
+# TAGFILES = file1=loc1 "file2 = loc2" ...
+# where loc1 and loc2 can be relative or absolute paths or URLs. See the
+# section "Linking to external documentation" for more information about the use
+# of tag files.
+# Note: Each tag file must have a unique name (where the name does NOT include
+# the path). If a tag file is not located in the directory in which doxygen is
+# run, you must also specify the path to the tagfile here.
+
+TAGFILES =
+
+# When a file name is specified after GENERATE_TAGFILE, doxygen will create a
+# tag file that is based on the input files it reads. See section "Linking to
+# external documentation" for more information about the usage of tag files.
+
+GENERATE_TAGFILE =
+
+# If the ALLEXTERNALS tag is set to YES, all external class will be listed in
+# the class index. If set to NO, only the inherited external classes will be
+# listed.
+# The default value is: NO.
+
+ALLEXTERNALS = NO
+
+# If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed
+# in the modules index. If set to NO, only the current project's groups will be
+# listed.
+# The default value is: YES.
+
+EXTERNAL_GROUPS = YES
+
+# If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in
+# the related pages index. If set to NO, only the current project's pages will
+# be listed.
+# The default value is: YES.
+
+EXTERNAL_PAGES = YES
+
+# The PERL_PATH should be the absolute path and name of the perl script
+# interpreter (i.e. the result of 'which perl').
+# The default file (with absolute path) is: /usr/bin/perl.
+
+PERL_PATH = /usr/bin/perl
+
+#---------------------------------------------------------------------------
+# Configuration options related to the dot tool
+#---------------------------------------------------------------------------
+
+# If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram
+# (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
+# NO turns the diagrams off. Note that this option also works with HAVE_DOT
+# disabled, but it is recommended to install and use dot, since it yields more
+# powerful graphs.
+# The default value is: YES.
+
+CLASS_DIAGRAMS = NO
+
+# You can define message sequence charts within doxygen comments using the \msc
+# command. Doxygen will then run the mscgen tool (see:
+# http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the
+# documentation. The MSCGEN_PATH tag allows you to specify the directory where
+# the mscgen tool resides. If left empty the tool is assumed to be found in the
+# default search path.
+
+MSCGEN_PATH =
+
+# You can include diagrams made with dia in doxygen documentation. Doxygen will
+# then run dia to produce the diagram and insert it in the documentation. The
+# DIA_PATH tag allows you to specify the directory where the dia binary resides.
+# If left empty dia is assumed to be found in the default search path.
+
+DIA_PATH =
+
+# If set to YES the inheritance and collaboration graphs will hide inheritance
+# and usage relations if the target is undocumented or is not a class.
+# The default value is: YES.
+
+HIDE_UNDOC_RELATIONS = NO
+
+# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
+# available from the path. This tool is part of Graphviz (see:
+# http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
+# Bell Labs. The other options in this section have no effect if this option is
+# set to NO
+# The default value is: NO.
+
+HAVE_DOT = YES
+
+# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
+# to run in parallel. When set to 0 doxygen will base this on the number of
+# processors available in the system. You can set it explicitly to a value
+# larger than 0 to get control over the balance between CPU load and processing
+# speed.
+# Minimum value: 0, maximum value: 32, default value: 0.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+DOT_NUM_THREADS = 0
+
+# When you want a differently looking font in the dot files that doxygen
+# generates you can specify the font name using DOT_FONTNAME. You need to make
+# sure dot is able to find the font, which can be done by putting it in a
+# standard location or by setting the DOTFONTPATH environment variable or by
+# setting DOT_FONTPATH to the directory containing the font.
+# The default value is: Helvetica.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+DOT_FONTNAME = Helvetica
+
+# The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
+# dot graphs.
+# Minimum value: 4, maximum value: 24, default value: 10.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+DOT_FONTSIZE = 10
+
+# By default doxygen will tell dot to use the default font as specified with
+# DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
+# the path where dot can find it using this tag.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+DOT_FONTPATH =
+
+# If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
+# each documented class showing the direct and indirect inheritance relations.
+# Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
+# The default value is: YES.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+CLASS_GRAPH = YES
+
+# If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
+# graph for each documented class showing the direct and indirect implementation
+# dependencies (inheritance, containment, and class references variables) of the
+# class with other documented classes.
+# The default value is: YES.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+COLLABORATION_GRAPH = YES
+
+# If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
+# groups, showing the direct groups dependencies.
+# The default value is: YES.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+GROUP_GRAPHS = YES
+
+# If the UML_LOOK tag is set to YES, doxygen will generate inheritance and
+# collaboration diagrams in a style similar to the OMG's Unified Modeling
+# Language.
+# The default value is: NO.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+UML_LOOK = NO
+
+# If the UML_LOOK tag is enabled, the fields and methods are shown inside the
+# class node. If there are many fields or methods and many nodes the graph may
+# become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
+# number of items for each type to make the size more manageable. Set this to 0
+# for no limit. Note that the threshold may be exceeded by 50% before the limit
+# is enforced. So when you set the threshold to 10, up to 15 fields may appear,
+# but if the number exceeds 15, the total amount of fields shown is limited to
+# 10.
+# Minimum value: 0, maximum value: 100, default value: 10.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+UML_LIMIT_NUM_FIELDS = 10
+
+# If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
+# collaboration graphs will show the relations between templates and their
+# instances.
+# The default value is: NO.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+TEMPLATE_RELATIONS = NO
+
+# If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
+# YES then doxygen will generate a graph for each documented file showing the
+# direct and indirect include dependencies of the file with other documented
+# files.
+# The default value is: YES.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+INCLUDE_GRAPH = YES
+
+# If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
+# set to YES then doxygen will generate a graph for each documented file showing
+# the direct and indirect include dependencies of the file with other documented
+# files.
+# The default value is: YES.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+INCLUDED_BY_GRAPH = YES
+
+# If the CALL_GRAPH tag is set to YES then doxygen will generate a call
+# dependency graph for every global function or class method.
+#
+# Note that enabling this option will significantly increase the time of a run.
+# So in most cases it will be better to enable call graphs for selected
+# functions only using the \callgraph command.
+# The default value is: NO.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+CALL_GRAPH = NO
+
+# If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
+# dependency graph for every global function or class method.
+#
+# Note that enabling this option will significantly increase the time of a run.
+# So in most cases it will be better to enable caller graphs for selected
+# functions only using the \callergraph command.
+# The default value is: NO.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+CALLER_GRAPH = NO
+
+# If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
+# hierarchy of all classes instead of a textual one.
+# The default value is: YES.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+GRAPHICAL_HIERARCHY = YES
+
+# If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
+# dependencies a directory has on other directories in a graphical way. The
+# dependency relations are determined by the #include relations between the
+# files in the directories.
+# The default value is: YES.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+DIRECTORY_GRAPH = YES
+
+# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
+# generated by dot.
+# Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
+# to make the SVG files visible in IE 9+ (other browsers do not have this
+# requirement).
+# Possible values are: png, jpg, gif and svg.
+# The default value is: png.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+DOT_IMAGE_FORMAT = png
+
+# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
+# enable generation of interactive SVG images that allow zooming and panning.
+#
+# Note that this requires a modern browser other than Internet Explorer. Tested
+# and working are Firefox, Chrome, Safari, and Opera.
+# Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
+# the SVG files visible. Older versions of IE do not have SVG support.
+# The default value is: NO.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+INTERACTIVE_SVG = NO
+
+# The DOT_PATH tag can be used to specify the path where the dot tool can be
+# found. If left blank, it is assumed the dot tool can be found in the path.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+DOT_PATH =
+
+# The DOTFILE_DIRS tag can be used to specify one or more directories that
+# contain dot files that are included in the documentation (see the \dotfile
+# command).
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+DOTFILE_DIRS =
+
+# The MSCFILE_DIRS tag can be used to specify one or more directories that
+# contain msc files that are included in the documentation (see the \mscfile
+# command).
+
+MSCFILE_DIRS =
+
+# The DIAFILE_DIRS tag can be used to specify one or more directories that
+# contain dia files that are included in the documentation (see the \diafile
+# command).
+
+DIAFILE_DIRS =
+
+# When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the
+# path where java can find the plantuml.jar file. If left blank, it is assumed
+# PlantUML is not used or called during a preprocessing step. Doxygen will
+# generate a warning when it encounters a \startuml command in this case and
+# will not generate output for the diagram.
+
+PLANTUML_JAR_PATH =
+
+# When using plantuml, the specified paths are searched for files specified by
+# the !include statement in a plantuml block.
+
+PLANTUML_INCLUDE_PATH =
+
+# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
+# that will be shown in the graph. If the number of nodes in a graph becomes
+# larger than this value, doxygen will truncate the graph, which is visualized
+# by representing a node as a red box. Note that doxygen if the number of direct
+# children of the root node in a graph is already larger than
+# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
+# the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
+# Minimum value: 0, maximum value: 10000, default value: 50.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+DOT_GRAPH_MAX_NODES = 50
+
+# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
+# generated by dot. A depth value of 3 means that only nodes reachable from the
+# root by following a path via at most 3 edges will be shown. Nodes that lay
+# further from the root node will be omitted. Note that setting this option to 1
+# or 2 may greatly reduce the computation time needed for large code bases. Also
+# note that the size of a graph can be further restricted by
+# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
+# Minimum value: 0, maximum value: 1000, default value: 0.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+MAX_DOT_GRAPH_DEPTH = 0
+
+# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
+# background. This is disabled by default, because dot on Windows does not seem
+# to support this out of the box.
+#
+# Warning: Depending on the platform used, enabling this option may lead to
+# badly anti-aliased labels on the edges of a graph (i.e. they become hard to
+# read).
+# The default value is: NO.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+DOT_TRANSPARENT = NO
+
+# Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output
+# files in one run (i.e. multiple -o and -T options on the command line). This
+# makes dot run faster, but since only newer versions of dot (>1.8.10) support
+# this, this feature is disabled by default.
+# The default value is: NO.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+DOT_MULTI_TARGETS = NO
+
+# If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
+# explaining the meaning of the various boxes and arrows in the dot generated
+# graphs.
+# The default value is: YES.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+GENERATE_LEGEND = YES
+
+# If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate dot
+# files that are used to generate the various graphs.
+# The default value is: YES.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+DOT_CLEANUP = YES
diff --git a/HISTORY b/HISTORY
new file mode 100644
index 0000000..4257424
--- /dev/null
+++ b/HISTORY
@@ -0,0 +1,26 @@
+I started this project as I wanted to use the same documentation process for my
+Perl code as I do for all the other code I write. Obviously the Perl "way" of
+documenting is to use POD, and while POD is great for small Perl projects in
+general, it does not in my opinion, provide a good tool for documenting large
+interconnected projects and frameworks.
+
+Doxygen does not currently support Perl natively so the only way to get Doxygen
+to support Perl is to pre-filter the Perl code and Perl comments in to a format
+that Doxygen can handle. This requires reading and parsing through the code and
+creating Java-Doc or C/C++ style comments out of the code.
+
+This project (Doxygen::Filter::Perl) represents completely new code based on the
+original work from the project DoxyGen::Filter written by Bart Schuller of Phinex
+Informatik AG and Thomas Aeby of Phinex Informatik AG. While this is all new code,
+credit for the concept and idea needs to go to Bart and Thomas. It is also important
+to note that I am taking over the DoxyGen::Filter project and further work of that
+code by permission from Thomas Aeby.
+
+A lot of users have contributed code and code ideas to this project and we welcome
+all future ideas and code submissions. One of the largest contributors of ideas
+and code comes from Kieron Taylor of the The European Bioinformatics Institute and
+Genome Research Limited.
+
+Special thanks goes to Zbynek Vyskovsky for the many patches, ideas, and features
+to help make this project more complete and allow developers to take advantage of
+nearlly all of the doxygen commands.
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..d645695
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,202 @@
+
+ Apache License
+ Version 2.0, January 2004
+ http://www.apache.org/licenses/
+
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+ 1. Definitions.
+
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+
+ 2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+
+ 3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+
+ 4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+
+ 6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for reasonable and customary use in describing the
+ origin of the Work and reproducing the content of the NOTICE file.
+
+ 7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied, including, without limitation, any warranties or conditions
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+
+ 8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+
+ 9. Accepting Warranty or Additional Liability. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or additional liability.
+
+ END OF TERMS AND CONDITIONS
+
+ APPENDIX: How to apply the Apache License to your work.
+
+ To apply the Apache License to your work, attach the following
+ boilerplate notice, with the fields enclosed by brackets "[]"
+ replaced with your own identifying information. (Don't include
+ the brackets!) The text should be enclosed in the appropriate
+ comment syntax for the file format. We also recommend that a
+ file or class name and description of purpose be included on the
+ same "printed page" as the copyright notice for easier
+ identification within third-party archives.
+
+ Copyright [yyyy] [name of copyright owner]
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
diff --git a/MANIFEST b/MANIFEST
new file mode 100644
index 0000000..8aade5c
--- /dev/null
+++ b/MANIFEST
@@ -0,0 +1,14 @@
+Changes
+Doxyfile
+HISTORY
+LICENSE
+Makefile.PL
+MANIFEST
+README.md
+bin/doxygen-filter-perl
+lib/Doxygen/Filter.pm
+lib/Doxygen/Filter/Perl.pm
+lib/Doxygen/Filter/Perl/POD.pm
+t/version.t
+META.yml Module YAML meta-data (added by MakeMaker)
+META.json Module JSON meta-data (added by MakeMaker)
diff --git a/META.json b/META.json
new file mode 100644
index 0000000..8637226
--- /dev/null
+++ b/META.json
@@ -0,0 +1,45 @@
+{
+ "abstract" : "Methods for pre-filtering Perl code for Doxygen",
+ "author" : [
+ "Bret Jordan"
+ ],
+ "dynamic_config" : 1,
+ "generated_by" : "ExtUtils::MakeMaker version 7.04, CPAN::Meta::Converter version 2.150001",
+ "license" : [
+ "unknown"
+ ],
+ "meta-spec" : {
+ "url" : "http://search.cpan.org/perldoc?CPAN::Meta::Spec",
+ "version" : "2"
+ },
+ "name" : "Doxygen-Filter-Perl",
+ "no_index" : {
+ "directory" : [
+ "t",
+ "inc"
+ ]
+ },
+ "prereqs" : {
+ "build" : {
+ "requires" : {
+ "ExtUtils::MakeMaker" : "0"
+ }
+ },
+ "configure" : {
+ "requires" : {
+ "ExtUtils::MakeMaker" : "0"
+ }
+ },
+ "runtime" : {
+ "requires" : {
+ "Log::Log4perl" : "1.46",
+ "Pod::POM" : "0.29",
+ "Pod::POM::View::HTML" : "1.06",
+ "Test::More" : "0.98",
+ "Test::Output" : "1.03"
+ }
+ }
+ },
+ "release_status" : "stable",
+ "version" : "1.72"
+}
diff --git a/META.yml b/META.yml
new file mode 100644
index 0000000..42fda8f
--- /dev/null
+++ b/META.yml
@@ -0,0 +1,26 @@
+---
+abstract: 'Methods for pre-filtering Perl code for Doxygen'
+author:
+ - 'Bret Jordan'
+build_requires:
+ ExtUtils::MakeMaker: '0'
+configure_requires:
+ ExtUtils::MakeMaker: '0'
+dynamic_config: 1
+generated_by: 'ExtUtils::MakeMaker version 7.04, CPAN::Meta::Converter version 2.150001'
+license: unknown
+meta-spec:
+ url: http://module-build.sourceforge.net/META-spec-v1.4.html
+ version: '1.4'
+name: Doxygen-Filter-Perl
+no_index:
+ directory:
+ - t
+ - inc
+requires:
+ Log::Log4perl: '1.46'
+ Pod::POM: '0.29'
+ Pod::POM::View::HTML: '1.06'
+ Test::More: '0.98'
+ Test::Output: '1.03'
+version: '1.72'
diff --git a/Makefile.PL b/Makefile.PL
new file mode 100644
index 0000000..2abd8cd
--- /dev/null
+++ b/Makefile.PL
@@ -0,0 +1,18 @@
+use 5.8.8;
+use ExtUtils::MakeMaker;
+# See lib/ExtUtils/MakeMaker.pm for details of how to influence
+# the contents of the Makefile that is written.
+WriteMakefile(
+ NAME => 'Doxygen::Filter::Perl',
+ VERSION_FROM => 'lib/Doxygen/Filter/Perl.pm', # finds $VERSION
+ ABSTRACT => 'Methods for pre-filtering Perl code for Doxygen',
+ PREREQ_PM => {
+ 'Pod::POM' => 0.29,
+ 'Pod::POM::View::HTML' => 1.06,
+ 'Log::Log4perl' => 1.46,
+ 'Test::More' => 0.98,
+ 'Test::Output' => 1.03,
+ },
+ AUTHOR => 'Bret Jordan',
+ EXE_FILES => ['bin/doxygen-filter-perl'],
+);
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..1a0a4f9
--- /dev/null
+++ b/README.md
@@ -0,0 +1,51 @@
+# Doxygen::Filter::Perl #
+
+## HOSTED AT ##
+ http://github.com/jordan2175/doxygen-filter-perl
+
+
+## MAJOR FEATURES ##
+
+ The major features of Doxygen::Filter::Perl are as follows:
+ Support for Doxygen style comments in Perl
+ Ability to convert POD comments in to Doxygen format
+
+
+## INSTALLATION ##
+
+ To install this module type the following:
+ perl Makefile.PL
+ make
+ make test
+ make install
+
+ Copy the Doxyfile doxygen config file out of this project and put it in the base of your project. You
+ will want to update at least the following fields in that Doxfile to match your project:
+ PROJECT_NAME
+ PROJECT_NUMBER
+
+
+## DEPENDENCIES ##
+
+ This module requires these other modules and libraries:
+ Pod::POM (0.29) [License = Perl]
+ Pod::POM::View::HTML (1.06) [License = Perl]
+ Log::Log4perl (1.46) [License = Perl]
+ Test::More (1.001014) [License = Perl]
+ Test::Output (1.03) [License = Perl]
+ IO::Handle (1.34)
+
+## LICENCE INFORMATION ##
+
+This is free software, licensed under the Apache License, Version 2.0.
+See the LICENSE file included with this package for license details.
+
+
+## AUTHOR ##
+
+Bret Jordan, jordan2175 at Google's mail system littledot com
+
+
+## COPYRIGHT ##
+
+Copyright (C) 2011 by Bret Jordan all rights reserved
diff --git a/bin/doxygen-filter-perl b/bin/doxygen-filter-perl
new file mode 100755
index 0000000..bd80199
--- /dev/null
+++ b/bin/doxygen-filter-perl
@@ -0,0 +1,79 @@
+#!/usr/bin/perl
+#
+#####################################################################
+# This program is not guaranteed to work at all, and by using this #
+# program you release the author of any and all liability. #
+# #
+# You may use this code as long as you are in compliance with the #
+# license (see the LICENSE file) and this notice, disclaimer and #
+# comment box remain intact and unchanged. #
+# #
+# Script: doxygen-filter-perl #
+# Description: pre-filter script for doxygen #
+# #
+# Written by: Bret Jordan (jordan at open1x littledot org) #
+# Created: 2011-10-21 #
+#####################################################################
+#
+#
+#
+#
+use 5.8.8;
+use strict;
+use warnings;
+use Doxygen::Filter::Perl;
+use Log::Log4perl;
+
+
+our $VERSION = '1.71';
+$VERSION = eval $VERSION;
+
+
+
+# You can not have any debugging turned on if you send the data through
+# doxygen as it will mess up the output. So before you run "doxygen Doxyfile"
+# make sure you have turned off all of the debugging. This is really only
+# here so you can run "doxygen-filter-perl lib/some/path/to/a/perl.pm" and get
+# debugging output
+my %hDebugConfig = (
+ 'log4perl.oneMessagePerAppender' => 1,
+ 'log4perl.rootlogger' => 'FATAL, SCREEN',
+ 'log4perl.logger.Doxygen::Filter::Perl::_ChangeState' => 'FATAL, SCREEN',
+ 'log4perl.logger.Doxygen::Filter::Perl::_ProcessDoxygenCommentBlock' => 'FATAL, SCREEN',
+ 'log4perl.logger.Doxygen::Filter::Perl::_ProcessPodCommentBlock' => 'FATAL, SCREEN',
+ 'log4perl.logger.Doxygen::Filter::Perl::_ProcessPerlMethod' => 'FATAL, SCREEN',
+ 'log4perl.logger.Doxygen::Filter::Perl::_ConvertPodFormattingToDoxygenFormat' => 'FATAL, SCREEN',
+ 'log4perl.logger.Doxygen::Filter::Perl::_RemovePerlCommentFlags' => 'FATAL, SCREEN',
+ 'log4perl.appender.SCREEN' => 'Log::Log4perl::Appender::Screen',
+ 'log4perl.appender.SCREEN.stderr' => 0,
+ 'log4perl.appender.SCREEN.Threshold' => 'DEBUG',
+ 'log4perl.appender.SCREEN.layout' => 'Log::Log4perl::Layout::PatternLayout',
+ 'log4perl.appender.SCREEN.layout.ConversionPattern' => '%-5p %L %M{1}() - %m%n',
+);
+
+Log::Log4perl::init(\%hDebugConfig);
+
+
+# Lets grab the file name that passed in to the script
+my $sFilename = $ARGV[0];
+
+unless (-r $sFilename) { die "This file is not readable\n"; }
+
+$sFilename =~ /\.([a-zA-Z]{1,4})$/;
+my $sFileExtention = lc($1);
+
+my $filter;
+if ( $sFileExtention eq 'pm' || $sFileExtention eq 'pl')
+{
+ $filter = new Doxygen::Filter::Perl();
+ $filter->ReadFile($sFilename);
+ $filter->ProcessFile();
+ $filter->PrintAll();
+}
+
+# Used for debugging
+#use Data::Dumper;
+#$Data::Dumper::Indent = 1;
+#print Dumper($filter->{'_hData'});
+
+
diff --git a/lib/Doxygen/Filter.pm b/lib/Doxygen/Filter.pm
new file mode 100644
index 0000000..23be1e5
--- /dev/null
+++ b/lib/Doxygen/Filter.pm
@@ -0,0 +1,53 @@
+#** @file Filter.pm
+# @verbatim
+#####################################################################
+# This program is not guaranteed to work at all, and by using this #
+# program you release the author of any and all liability. #
+# #
+# You may use this code as long as you are in compliance with the #
+# license (see the LICENSE file) and this notice, disclaimer and #
+# comment box remain intact and unchanged. #
+# #
+# Package: Doxygen #
+# Class: Filter #
+# Description: Methods for prefiltering code for Doxygen #
+# #
+# Written by: Bret Jordan (jordan at open1x littledot org) #
+# Created: 2011-10-13 #
+#####################################################################
+# @endverbatim
+#
+# @copy 2011, Bret Jordan (jordan2175 at gmail.com, jordan at open1x.org)
+# $Id: Filter.pm 88 2012-07-07 04:27:35Z jordan2175 $
+#*
+package Doxygen::Filter;
+
+use 5.8.8;
+use strict;
+use warnings;
+use Log::Log4perl;
+
+our $VERSION = '1.72';
+$VERSION = eval $VERSION;
+
+
+
+sub GetLogger
+{
+ #** @method public GetLogger ($object)
+ # This method is a helper method to get the Log4perl logger object ane make sure
+ # it knows from which class it was called regardless of where it actually lives.
+ #*
+ my $self = shift;
+ my $object = shift;
+ my $package = ref($object);
+ my @data = caller(1);
+ my $caller = (split "::", $data[3])[-1];
+ my $sLoggerName = $package . "::" . $caller;
+ print "+++ DEBUGGER +++ $sLoggerName\n" if ($self->{'_iDebug'} == 1);
+
+ return Log::Log4perl->get_logger("$sLoggerName");
+}
+
+
+return 1;
diff --git a/lib/Doxygen/Filter/Perl.pm b/lib/Doxygen/Filter/Perl.pm
new file mode 100644
index 0000000..6c3180f
--- /dev/null
+++ b/lib/Doxygen/Filter/Perl.pm
@@ -0,0 +1,1281 @@
+#** @file Perl.pm
+# @verbatim
+#####################################################################
+# This program is not guaranteed to work at all, and by using this #
+# program you release the author of any and all liability. #
+# #
+# You may use this code as long as you are in compliance with the #
+# license (see the LICENSE file) and this notice, disclaimer and #
+# comment box remain intact and unchanged. #
+# #
+# Package: Doxygen::Filter #
+# Class: Perl #
+# Description: Methods for prefiltering Perl code for Doxygen #
+# #
+# Written by: Bret Jordan (jordan at open1x littledot org) #
+# Created: 2011-10-13 #
+#####################################################################
+# @endverbatim
+#
+# @copy 2011, Bret Jordan (jordan2175 at gmail.com, jordan at open1x.org)
+# $Id: Perl.pm 93 2015-03-17 13:08:02Z jordan2175 $
+#*
+package Doxygen::Filter::Perl;
+
+use 5.8.8;
+use strict;
+use warnings;
+use parent qw(Doxygen::Filter);
+use Log::Log4perl;
+use Pod::POM;
+use IO::Handle;
+use Doxygen::Filter::Perl::POD;
+
+our $VERSION = '1.72';
+$VERSION = eval $VERSION;
+
+
+# Define State Engine Values
+my $hValidStates = {
+ 'NORMAL' => 0,
+ 'COMMENT' => 1,
+ 'DOXYGEN' => 2,
+ 'POD' => 3,
+ 'METHOD' => 4,
+ 'DOXYFILE' => 21,
+ 'DOXYCLASS' => 22,
+ 'DOXYFUNCTION' => 23,
+ 'DOXYMETHOD' => 24,
+ 'DOXYCOMMENT' => 25,
+};
+
+
+our %SYSTEM_PACKAGES = map({ $_ => 1 } qw(
+ base
+ warnings
+ strict
+ Exporter
+ vars
+));
+
+
+
+sub new
+{
+ #** @method private new ()
+ # This is the constructor and it calls _init() to initiate
+ # the various variables
+ #*
+ my $pkg = shift;
+ my $class = ref($pkg) || $pkg;
+
+ my $self = {};
+ bless ($self, $class);
+
+ # Lets send any passed in arguments to the _init method
+ $self->_init(@_);
+ return $self;
+}
+
+sub DESTROY
+{
+ #** @method private DESTROY ()
+ # This is the destructor
+ #*
+ my $self = shift;
+ $self = {};
+}
+
+sub RESETSUB
+{
+ my $self = shift;
+ $self->{'_iOpenBrace'} = 0;
+ $self->{'_iCloseBrace'} = 0;
+ $self->{'_sCurrentMethodName'} = undef;
+ $self->{'_sCurrentMethodType'} = undef;
+ $self->{'_sCurrentMethodState'} = undef;
+}
+
+sub RESETFILE { shift->{'_aRawFileData'} = []; }
+
+sub RESETCLASS
+{
+ my $self = shift;
+ #$self->{'_sCurrentClass'} = 'main';
+ #push (@{$self->{'_hData'}->{'class'}->{'classorder'}}, 'main');
+ $self->_SwitchClass('main');
+}
+
+sub RESETDOXY { shift->{'_aDoxygenBlock'} = []; }
+sub RESETPOD { shift->{'_aPodBlock'} = []; }
+
+
+
+sub _init
+{
+ #** @method private _init ()
+ # This method is used in the constructor to initiate
+ # the various variables in the object
+ #*
+ my $self = shift;
+ $self->{'_iDebug'} = 0;
+ $self->{'_sState'} = undef;
+ $self->{'_sPreviousState'} = [];
+ $self->_ChangeState('NORMAL');
+ $self->{'_hData'} = {};
+ $self->RESETFILE();
+ $self->RESETCLASS();
+ $self->RESETSUB();
+ $self->RESETDOXY();
+ $self->RESETPOD();
+}
+
+
+
+
+# ----------------------------------------
+# Public Methods
+# ----------------------------------------
+sub GetCurrentClass
+{
+ my $self = shift;
+ return $self->{'_hData'}->{'class'}->{$self->{'_sCurrentClass'}};
+}
+
+sub ReadFile
+{
+ #** @method public ReadFile ($sFilename)
+ # This method will read the contents of the file in to an array
+ # and store that in the object as $self->{'_aRawFileData'}
+ # @param sFilename - required string (filename to use)
+ #*
+ my $self = shift;
+ my $sFilename = shift;
+ my $logger = $self->GetLogger($self);
+ $logger->debug("### Entering ReadFile ###");
+
+ # Lets record the file name in the data structure
+ $self->{'_hData'}->{'filename'}->{'fullpath'} = $sFilename;
+
+ # Replace forward slash with a black slash
+ $sFilename =~ s/\\/\//g;
+ # Remove windows style drive letters
+ $sFilename =~ s/^.*://;
+
+ # Lets grab just the file name not the full path for the short name
+ $sFilename =~ /^(.*\/)*(.*)$/;
+ $self->{'_hData'}->{'filename'}->{'shortname'} = $2;
+
+ open(DATAIN, $sFilename);
+ #my @aFileData = <DATAIN>;
+ my @aFileData = map({ s/\r$//g; $_; } <DATAIN>);
+ close (DATAIN);
+ $self->{'_aRawFileData'} = \@aFileData;
+}
+
+sub ReportError
+{
+ #** @method public void ReportError($message)
+ # @brief Reports an error message in the current context.
+ #
+ # The message is prepended by 'filename:lineno: error:' prefix so it is easily
+ # parseable by IDEs and advanced editors.
+ #*
+ my $self = shift;
+ my $message = shift;
+
+ my $hData = $self->{'_hData'};
+ my $header = "$hData->{filename}->{fullpath}:$hData->{lineno}: error: ";
+ $message .= "\n" if (substr($message, -1, 1) ne "\n");
+ $message =~ s/^/$header/gm;
+ STDERR->print($message);
+}
+
+sub ProcessFile
+{
+ #** @method public ProcessFile ()
+ # This method is a state machine that will search down each line of code to see what it should do
+ #*
+ my $self = shift;
+ my $logger = $self->GetLogger($self);
+ $logger->debug("### Entering ProcessFile ###");
+
+ $self->{'_hData'}->{'lineno'} = 0;
+ foreach my $line (@{$self->{'_aRawFileData'}})
+ {
+ $self->{'_hData'}->{'lineno'}++;
+ # Convert syntax block header to supported doxygen form, if this line is a header
+ $line = $self->_ConvertToOfficialDoxygenSyntax($line);
+
+ # Lets first figure out what state we SHOULD be in and then we will deal with
+ # processing that state. This first block should walk through all the possible
+ # transition states, aka, the states you can get to from the state you are in.
+ if ($self->{'_sState'} eq 'NORMAL')
+ {
+ $logger->debug("We are in state: NORMAL");
+ if ($line =~ /^\s*sub\s*(.*)/) { $self->_ChangeState('METHOD'); }
+ elsif ($line =~ /^\s*#\*\*\s*\@/) { $self->_ChangeState('DOXYGEN'); }
+ elsif ($line =~ /^=.*/) { $self->_ChangeState('POD'); }
+ }
+ elsif ($self->{'_sState'} eq 'METHOD')
+ {
+ $logger->debug("We are in state: METHOD");
+ if ($line =~ /^\s*#\*\*\s*\@/ ) { $self->_ChangeState('DOXYGEN'); }
+ }
+ elsif ($self->{'_sState'} eq 'DOXYGEN')
+ {
+ $logger->debug("We are in state: DOXYGEN");
+ # If there are no more comments, then reset the state to the previous state
+ unless ($line =~ /^\s*#/)
+ {
+ # The general idea is we gather the whole doxygen comment in to an array and process
+ # that array all at once in the _ProcessDoxygenCommentBlock. This way we do not have
+ # to artifically keep track of what type of comment block it is between each line
+ # that we read from the file.
+ $logger->debug("End of Doxygen Comment Block");
+ $self->_ProcessDoxygenCommentBlock();
+ $self->_RestoreState();
+ $logger->debug("We are in state $self->{'_sState'}");
+ if ($self->{'_sState'} eq 'NORMAL')
+ {
+ # If this comment block is right next to a subroutine, lets make sure we
+ # handle that condition
+ if ($line =~ /^\s*sub\s*(.*)/) { $self->_ChangeState('METHOD'); }
+ }
+ }
+ }
+ elsif ($self->{'_sState'} eq 'POD')
+ {
+ if ($line =~ /^=cut/)
+ {
+ push (@{$self->{'_aPodBlock'}}, $line);
+ $self->_ProcessPodCommentBlock();
+ $self->_RestoreState();
+ }
+ }
+
+
+ # Process states
+ if ($self->{'_sState'} eq 'NORMAL')
+ {
+ if ($line =~ /^\s*package\s*(.*)\;$/)
+ {
+ #$self->{'_sCurrentClass'} = $1;
+ #push (@{$self->{'_hData'}->{'class'}->{'classorder'}}, $1);
+ $self->_SwitchClass($1);
+ }
+ elsif ($line =~ /our\s+\$VERSION\s*=\s*(.*);$/)
+ {
+ # our $VERSION = '0.99_01';
+ # use version; our $VERSION = qv('0.3.1'); - Thanks Hoppfrosch for the suggestion
+ my $version = $1;
+ $version =~ s/[\'\"\(\)\;]//g;
+ $version =~ s/qv//;
+ $self->{'_hData'}->{'filename'}->{'version'} = $version;
+ }
+ #elsif ($line =~ /^\s*use\s+([\w:]+)/)
+ elsif ($line =~ /^\s*use\s+([\w:]+)(|\s*(\S.*?)\s*;*)$/)
+ {
+ my $sIncludeModule = $1;
+ my $x = $2;
+ my $expr = $3;
+ if (defined($sIncludeModule))
+ {
+ #unless ($sIncludeModule eq "strict" || $sIncludeModule eq "warnings" || $sIncludeModule eq "vars" || $sIncludeModule eq "Exporter" || $sIncludeModule eq "base")
+ if ($sIncludeModule =~ m/^(base|strict|warnings|vars|Exporter)$/)
+ {
+ if ($sIncludeModule eq "base")
+ {
+ my @isa = eval($expr);
+ push(@{$self->GetCurrentClass()->{inherits}}, _FilterOutSystemPackages(@isa)) unless ($@);
+ }
+ else
+ {
+ # ignore other system modules
+ }
+ }
+ else
+ {
+ # Allows doxygen to know where to look for other packages
+ $sIncludeModule =~ s/::/\//g;
+ push (@{$self->{'_hData'}->{'includes'}}, $sIncludeModule);
+ }
+ }
+ }
+ #elsif ($line =~ /^\s*(?:Readonly\s+)?(?:my|our)\s+([\$@%*]\w+)/)
+ #elsif ($line =~ /^\s*(?:Readonly\s+)?(my|our)\s+([\$@%*]\w+)([^=]*|\s*=\s*(\S.*?)\s*;*)$/)
+ elsif ($line =~ /^\s*(?:Readonly\s+)?(my|our)\s+(([\$@%*])(\w+))([^=]*|\s*=\s*(\S.*?)\s*;*)$/)
+ {
+ # Lets look for locally defined variables/arrays/hashes and capture them such as:
+ # my $var;
+ # my $var = ...
+ # our @var = ...
+ # Readonly our %var ...
+ #my $sAttrName = $1;
+ #if (defined($sAttrName) && $sAttrName !~ m/^(\@EXPORT|\@EXPORT_OK|\$VERSION)$/)
+ my $scope = $1;
+ my $fullName = $2;
+ my $typeCode = $3;
+ my $sAttrName = $4;
+ my $expr = $6;
+
+ if (defined $sAttrName)
+ {
+ #my $sClassName = $self->{'_sCurrentClass'};
+ #push (@{$self->{'_hData'}->{'class'}->{$sClassName}->{attributeorder}}, $sAttrName);
+ if ($scope eq "our" && $fullName =~ m/^(\@ISA|\@EXPORT|\@EXPORT_OK|\$VERSION)$/)
+ {
+ if ($fullName eq "\@ISA" && defined $expr)
+ {
+ my @isa = eval($expr);
+ push(@{$self->GetCurrentClass()->{inherits}}, _FilterOutSystemPackages(@isa)) unless ($@);
+ }
+ else
+ {
+ # ignore other system variables
+ }
+ }
+ else
+ {
+ my $sClassName = $self->{'_sCurrentClass'};
+ if (!exists $self->{'_hData'}->{'class'}->{$sClassName}->{attributes}->{$sAttrName})
+ {
+ # only define the attribute if it was not yet defined by doxygen comment
+ my $attrDef = $self->{'_hData'}->{'class'}->{$sClassName}->{attributes}->{$sAttrName} = {
+ type => $self->_ConvertTypeCode($typeCode),
+ modifiers => "static ",
+ state => $scope eq "my" ? "private" : "public",
+ };
+ push(@{$self->{'_hData'}->{'class'}->{$sClassName}->{attributeorder}}, $sAttrName);
+ }
+ }
+ }
+ if ($line =~ /(#\*\*\s+\@.*$)/)
+ {
+ # Lets look for an single in-line doxygen comment on a variable, array, or hash declaration
+ my $sBlock = $1;
+ push (@{$self->{'_aDoxygenBlock'}}, $sBlock);
+ $self->_ProcessDoxygenCommentBlock();
+ }
+ }
+ }
+ elsif ($self->{'_sState'} eq 'METHOD') { $self->_ProcessPerlMethod($line); }
+ elsif ($self->{'_sState'} eq 'DOXYGEN') { push (@{$self->{'_aDoxygenBlock'}}, $line); }
+ elsif ($self->{'_sState'} eq 'POD') { push (@{$self->{'_aPodBlock'}}, $line);}
+ }
+}
+
+sub PrintAll
+{
+ #** @method public PrintAll ()
+ # This method will print out the entire data structure in a form that Doxygen can work with.
+ # It is important to note that you are basically making the output look like C code so that
+ # packages and classes need to have start and end blocks and need to include all of the
+ # elements that are part of that package or class
+ #*
+ my $self = shift;
+ my $logger = $self->GetLogger($self);
+ $logger->debug("### Entering PrintAll ###");
+
+ $self->_PrintFilenameBlock();
+ $self->_PrintIncludesBlock();
+
+ foreach my $class (@{$self->{'_hData'}->{'class'}->{'classorder'}})
+ {
+ my $classDef = $self->{'_hData'}->{'class'}->{$class};
+
+ # skip the default main class unless we really have something to print
+ if ($class eq "main" &&
+ @{$classDef->{attributeorder}} == 0 &&
+ @{$classDef->{subroutineorder}} == 0 &&
+ (!defined $classDef->{details}) &&
+ (!defined $classDef->{comments})
+ )
+ {
+ next;
+ }
+
+ $self->_PrintClassBlock($class);
+
+ # Print all available attributes first that are defined at the global class level
+ foreach my $sAttrName (@{$self->{'_hData'}->{'class'}->{$class}->{'attributeorder'}})
+ {
+ my $attrDef = $self->{'_hData'}->{'class'}->{$class}->{'attributes'}->{$sAttrName};
+
+ my $sState = $attrDef->{'state'} || 'public';
+ my $sComments = $attrDef->{'comments'};
+ my $sDetails = $attrDef->{'details'};
+ if (defined $sComments || defined $sDetails)
+ {
+ print "/**\n";
+ if (defined $sComments)
+ {
+ print " \* \@brief $sComments\n";
+ }
+
+ if ($sDetails)
+ {
+ print " * \n".$sDetails;
+ }
+
+ print " */\n";
+ }
+
+ print("$sState:\n$attrDef->{modifiers}$attrDef->{type} $sAttrName;\n\n");
+ }
+
+ # Print all functions/methods in order of appearance, let doxygen take care of grouping them according to modifiers
+ # I added this print public line to make sure the functions print if one of
+ # the previous elements was a my $a = 1 and thus had a print "private:"
+ # This is no longer needed, fixed it in the Doxyfile instead.
+ # print("public:\n");
+ foreach my $methodName (@{$self->{'_hData'}->{'class'}->{$class}->{'subroutineorder'}})
+ {
+ $self->_PrintMethodBlock($class, $methodName);
+ }
+ # Print end of class mark
+ print "}\;\n";
+ # print end of namespace if class is nested
+ print "};\n" if ($class =~ /::/);
+ }
+}
+
+
+# ----------------------------------------
+# Private Methods
+# ----------------------------------------
+sub _FilterOutSystemPackages { return grep({ !exists $SYSTEM_PACKAGES{$_} } @_); }
+
+sub _SwitchClass
+{
+ my $self = shift;
+ my $class = shift;
+
+ $self->{'_sCurrentClass'} = $class;
+ if (!exists $self->{'_hData'}->{'class'}->{$class})
+ {
+ push(@{$self->{'_hData'}->{'class'}->{'classorder'}}, $class);
+ $self->{'_hData'}->{'class'}->{$class} = {
+ classname => $class,
+ inherits => [],
+ attributeorder => [],
+ subroutineorder => [],
+ };
+ }
+
+ return $self->{'_hData'}->{'class'}->{$class};
+}
+
+sub _RestoreState { shift->_ChangeState(); }
+sub _ChangeState
+{
+ #** @method private _ChangeState ($state)
+ # This method will change and keep track of the various states that the state machine
+ # transitions to and from. Having this information allows you to return to a previous
+ # state. If you pass nothing in to this method it will restore the previous state.
+ # @param state - optional string (state to change to)
+ #*
+ my $self = shift;
+ my $state = shift;
+ my $logger = $self->GetLogger($self);
+ $logger->debug("### Entering _ChangeState ###");
+
+ if (defined $state && exists $hValidStates->{$state})
+ {
+ # If there was a value passed in and it is a valid value lets make it active
+ $logger->debug("State passed in: $state");
+ unless (defined $self->{'_sState'} && $self->{'_sState'} eq $state)
+ {
+ # Need to push the current state to the array BEFORE we change it and only
+ # if we are not currently at that state
+ push (@{$self->{'_sPreviousState'}}, $self->{'_sState'});
+ $self->{'_sState'} = $state;
+ }
+ }
+ else
+ {
+ # If nothing is passed in, lets set the current state to the preivous state.
+ $logger->debug("No state passed in, lets revert to previous state");
+ my $previous = pop @{$self->{'_sPreviousState'}};
+ if (defined $previous)
+ {
+ $logger->debug("Previous state was $previous");
+ }
+ else
+ {
+ $logger->error("There is no previous state! Setting to NORMAL");
+ $previous = 'NORMAL';
+ }
+ $self->{'_sState'} = $previous;
+ }
+}
+
+sub _PrintFilenameBlock
+{
+ #** @method private _PrintFilenameBlock ()
+ # This method will print the filename section in appropriate doxygen syntax
+ #*
+ my $self = shift;
+ my $logger = $self->GetLogger($self);
+ $logger->debug("### Entering _PrintFilenameBlock ###");
+
+ if (defined $self->{'_hData'}->{'filename'}->{'fullpath'})
+ {
+ print "/** \@file $self->{'_hData'}->{'filename'}->{'fullpath'}\n";
+ if (defined $self->{'_hData'}->{'filename'}->{'details'}) { print "$self->{'_hData'}->{'filename'}->{'details'}\n"; }
+ if (defined $self->{'_hData'}->{'filename'}->{'version'}) { print "\@version $self->{'_hData'}->{'filename'}->{'version'}\n"; }
+ print "*/\n";
+ }
+}
+
+sub _PrintIncludesBlock
+{
+ #** @method private _PrintIncludesBlock ()
+ # This method will print the various extra modules that are used
+ #*
+ my $self = shift;
+ my $logger = $self->GetLogger($self);
+ $logger->debug("### Entering _PrintIncludeBlock ###");
+
+ foreach my $include (@{$self->{'_hData'}->{'includes'}})
+ {
+ print "\#include \"$include.pm\"\n";
+ }
+ print "\n";
+}
+
+sub _PrintClassBlock
+{
+ #** @method private _PrintClassBlock ($sFullClass)
+ # This method will print the class/package block in appropriate doxygen syntax
+ # @param sFullClass - required string (full name of the class)
+ #*
+ my $self = shift;
+ my $sFullClass = shift;
+ my $logger = $self->GetLogger($self);
+ $logger->debug("### Entering _PrintClassBlock ###");
+
+ # We need to reset the $1 / $2 match for perl scripts without package classes.
+ # so lets do it here just to be save. Yes this is an expensive way of doing it
+ # but it works.
+ $sFullClass =~ /./;
+ $sFullClass =~ /(.*)\:\:(\w+)$/;
+ my $parent = $1;
+ my $class = $2 || $sFullClass;
+
+ print "/** \@class $sFullClass\n";
+
+ my $classDef = $self->{'_hData'}->{'class'}->{$sFullClass};
+
+ my $details = $self->{'_hData'}->{'class'}->{$sFullClass}->{'details'};
+ if (defined $details) { print "$details\n"; }
+
+ my $comments = $self->{'_hData'}->{'class'}->{$sFullClass}->{'comments'};
+ if (defined $comments) { print "$comments\n"; }
+
+ print "\@nosubgrouping */\n";
+
+ #if (defined $parent) { print "class $sFullClass : public $parent { \n"; }
+ #else { print "class $sFullClass { \n"; }
+ print "namespace $parent {\n" if ($parent);
+ print "class $class";
+ if (@{$classDef->{inherits}})
+ {
+ my $count = 0;
+ foreach my $inherit (@{$classDef->{inherits}})
+ {
+ print(($count++ == 0 ? ": " : ", ")." public ::".$inherit);
+ }
+ }
+ print "\n{\n";
+ print "public:\n";
+}
+
+sub _PrintMethodBlock
+{
+ #** @method private _PrintMethodBlock ($class, $methodDef)
+ # This method will print the various subroutines/functions/methods in apprporiate doxygen syntax
+ # @param class - required string (name of the class)
+ # @param state - required string (current state)
+ # @param type - required string (type)
+ # @param method - required string (name of method)
+ #*
+ my $self = shift;
+ my $class = shift;
+ my $method = shift;
+
+ my $methodDef = $self->{'_hData'}->{'class'}->{$class}->{'subroutines'}->{$method};
+
+ my $state = $methodDef->{state};
+ my $type = $methodDef->{type};
+
+ my $logger = $self->GetLogger($self);
+ $logger->debug("### Entering _PrintMethodBlock ###");
+
+ my $returntype = $methodDef->{'returntype'} || $type;
+ my $parameters = $methodDef->{'parameters'} || "";
+
+ print "/** \@fn $state $returntype $method\($parameters\)\n";
+
+ my $details = $methodDef->{'details'};
+ if (defined $details) { print "$details\n"; }
+ else { print "Undocumented Method\n"; }
+
+ my $comments = $methodDef->{'comments'};
+ if (defined $comments) { print "$comments\n"; }
+
+ # Print collapsible source code block
+ print "\@htmlonly\n";
+ print "<div id='codesection-$method' class='dynheader closed' style='cursor:pointer;' onclick='return toggleVisibility(this)'>\n";
+ print "\t<img id='codesection-$method-trigger' src='closed.png' style='display:inline'><b>Code:</b>\n";
+ print "</div>\n";
+ print "<div id='codesection-$method-summary' class='dyncontent' style='display:block;font-size:small;'>click to view</div>\n";
+ print "<div id='codesection-$method-content' class='dyncontent' style='display: none;'>\n";
+ print "\@endhtmlonly\n";
+
+ print "\@code\n";
+ print "\# Number of lines of code in $method: $methodDef->{'length'}\n";
+ print "$methodDef->{'code'}\n";
+ print "\@endcode \@htmlonly\n";
+ print "</div>\n";
+ print "\@endhtmlonly */\n";
+
+ print "$state $returntype $method\($parameters\)\;\n";
+}
+
+sub _ProcessPerlMethod
+{
+ #** @method private _ProcessPerlMethod ($line)
+ # This method will process the contents of a subroutine/function/method and try to figure out
+ # the name and wether or not it is a private or public method. The private or public status,
+ # if not defined in a doxygen comment block will be determined based on the file name. As with
+ # C and other languages, an "_" should be the first character for all private functions/methods.
+ # @param line - required string (full line of code)
+ #*
+ my $self = shift;
+ my $line = shift;
+ my $logger = $self->GetLogger($self);
+ $logger->debug("### Entering _ProcessPerlMethod ###");
+
+ my $sClassName = $self->{'_sCurrentClass'};
+
+ if ($line =~ /^\s*sub\s+(.*)/)
+ {
+ # We should keep track of the order in which the methods were written in the code so we can print
+ # them out in the same order
+ my $sName = $1;
+ # If they have declared the subrountine with a brace on the same line, lets remove it
+ $sName =~ s/\{.*\}?//;
+ # Remove any leading or trailing whitespace from the name, just to be safe
+ $sName =~ s/\s//g;
+ $logger->debug("Method Name: $sName");
+
+ push (@{$self->{'_hData'}->{'class'}->{$sClassName}->{'subroutineorder'}}, $sName);
+ $self->{'_sCurrentMethodName'} = $sName;
+ }
+ my $sMethodName = $self->{'_sCurrentMethodName'};
+
+ # Lets find out if this is a public or private method/function based on a naming standard
+ if ($sMethodName =~ /^_/) { $self->{'_sCurrentMethodState'} = 'private'; }
+ else { $self->{'_sCurrentMethodState'} = 'public'; }
+
+ my $sMethodState = $self->{'_sCurrentMethodState'};
+ $logger->debug("Method State: $sMethodState");
+
+ # We need to count the number of open and close braces so we can see if we are still in a subroutine or not
+ # but we need to becareful so that we do not count braces in comments and braces that are in match patters /\{/
+ # If there are more open then closed, then we are still in a subroutine
+ my $cleanline = $line;
+ $logger->debug("Cleanline: $cleanline");
+
+ # Remove any comments even those inline with code but not if the hash mark "#" is in a pattern match
+ # unless ($cleanline =~ /=~/) { $cleanline =~ s/#.*$//; }
+ # Patch from Stefan Tauner to address hash marks showing up at the last element of an array, $#array
+ unless ($cleanline =~ /=~/) { $cleanline =~ s/([^\$])#.*$/$1/; }
+ $logger->debug("Cleanline: $cleanline");
+ # Need to remove braces from counting when they are in a pattern match but not when they are supposed to be
+ # there as in the second use case listed below. Below the use cases is some ideas on how to do this.
+ # use case: $a =~ /\{/
+ # use case: if (/\{/) { foo; }
+ # use case: unless ($cleanline =~ /=~/) { $cleanline =~ s/#.*$//; }
+ $cleanline =~ s#/.*?/##g;
+ $logger->debug("Cleanline: $cleanline");
+ # Remove any braces found in a print statement lile:
+ # use case: print "some foo { bar somethingelse";
+ # use case: print "$self->{'_hData'}->{'filename'}->{'details'}\n";
+ if ($cleanline =~ /(.*?print\s*)(.*?);(.*)/)
+ {
+ my $sLineData1 = $1;
+ my $sLineData2 = $2;
+ my $sLineData3 = $3;
+ $sLineData2 =~ s#[{}]##g;
+ $cleanline = $sLineData1 . $sLineData2. $sLineData3;
+ }
+ #$cleanline =~ s/(print\s*\".*){(.*\")/$1$2/g;
+ $logger->debug("Cleanline: $cleanline");
+
+ $self->{'_iOpenBrace'} += @{[$cleanline =~ /\{/g]};
+ $self->{'_iCloseBrace'} += @{[$cleanline =~ /\}/g]};
+ $logger->debug("Open Brace Number: $self->{'_iOpenBrace'}");
+ $logger->debug("Close Brace Number: $self->{'_iCloseBrace'}");
+
+
+ # Use Case 1: sub foo { return; }
+ # Use Case 2: sub foo {\n}
+ # Use Case 3: sub foo \n {\n }
+
+ if ($self->{'_iOpenBrace'} > $self->{'_iCloseBrace'})
+ {
+ # Use Case 2, still in subroutine
+ $logger->debug("We are still in the subroutine");
+ }
+ elsif ($self->{'_iOpenBrace'} > 0 && $self->{'_iOpenBrace'} == $self->{'_iCloseBrace'})
+ {
+ # Use Case 1, we are leaving a subroutine
+ $logger->debug("We are leaving the subroutine");
+ $self->_ChangeState('NORMAL');
+ $self->RESETSUB();
+ }
+ else
+ {
+ # Use Case 3, still in subroutine
+ $logger->debug("A subroutine has been started but we are not yet in it as we have yet to see an open brace");
+ }
+
+ # Doxygen makes use of the @ symbol and treats it as a special reserved character. This is a problem for perl
+ # and especailly when we are documenting our own Doxygen code we have print statements that include things like @endcode
+ # as is found in _PrintMethodBlock(). Lets convert those @ to @amp;
+ $line =~ s/\@endcode/\&\#64\;endcode/g;
+
+ # Record the current line for code output
+ $self->{'_hData'}->{'class'}->{$sClassName}->{'subroutines'}->{$sMethodName}->{'code'} .= $line;
+ $self->{'_hData'}->{'class'}->{$sClassName}->{'subroutines'}->{$sMethodName}->{'length'}++;
+
+ # Only set these values if they were not already set by a comment block outside the subroutine
+ # This is for public/private
+ unless (defined $self->{'_hData'}->{'class'}->{$sClassName}->{'subroutines'}->{$sMethodName}->{'state'})
+ {
+ $self->{'_hData'}->{'class'}->{$sClassName}->{'subroutines'}->{$sMethodName}->{'state'} = $sMethodState;
+ }
+ # This is for function/method
+ unless (defined $self->{'_hData'}->{'class'}->{$sClassName}->{'subroutines'}->{$sMethodName}->{'type'})
+ {
+ $self->{'_hData'}->{'class'}->{$sClassName}->{'subroutines'}->{$sMethodName}->{'type'} = "method";
+ }
+}
+
+sub _ProcessPodCommentBlock
+{
+ #** @method private _ProcessPodCommentBlock ()
+ # This method will process an entire POD block in one pass, after it has all been gathered by the state machine.
+ #*
+ my $self = shift;
+ my $logger = $self->GetLogger($self);
+ $logger->debug("### Entering _ProcessPodCommentBlock ###");
+
+ my $sClassName = $self->{'_sCurrentClass'};
+ my @aBlock = @{$self->{'_aPodBlock'}};
+
+ # Lets clean up the array in the object now that we have a local copy as we will no longer need that. We want to make
+ # sure it is all clean and ready for the next comment block
+ $self->RESETPOD();
+
+ my $sPodRawText;
+ foreach (@aBlock)
+ {
+ # If we find any Doxygen special characters in the POD, lets escape them
+ s/(\@|\\|\%|#)/\\$1/g;
+ $sPodRawText .= $_;
+ }
+
+ my $parser = new Pod::POM();
+ my $pom = $parser->parse_text($sPodRawText);
+ my $sPodParsedText = Doxygen::Filter::Perl::POD->print($pom);
+
+ $self->{'_hData'}->{'class'}->{$sClassName}->{'comments'} .= $sPodParsedText;
+}
+
+
+sub _ProcessDoxygenCommentBlock
+{
+ #** @method private _ProcessDoxygenCommentBlock ()
+ # This method will process an entire comment block in one pass, after it has all been gathered by the state machine
+ #*
+ my $self = shift;
+ my $logger = $self->GetLogger($self);
+ $logger->debug("### Entering _ProcessDoxygenCommentBlock ###");
+
+ my @aBlock = @{$self->{'_aDoxygenBlock'}};
+
+ # Lets clean up the array in the object now that we have a local copy as we will no longer need that. We want to make
+ # sure it is all clean and ready for the next comment block
+ $self->RESETDOXY();
+
+ my $sClassName = $self->{'_sCurrentClass'};
+ my $sSubState = '';
+ $logger->debug("We are currently in class $sClassName");
+
+ # Lets grab the command line and put it in a variable for easier use
+ my $sCommandLine = $aBlock[0];
+ $logger->debug("The command line for this doxygen comment is $sCommandLine");
+
+ $sCommandLine =~ /^\s*#\*\*\s+\@([\w:]+)\s+(.*)/;
+ my $sCommand = lc($1);
+ my $sOptions = $2;
+ $logger->debug("Command: $sCommand");
+ $logger->debug("Options: $sOptions");
+
+ # If the user entered @fn instead of @function, lets change it
+ if ($sCommand eq "fn") { $sCommand = "function"; }
+
+ # Lets find out what doxygen sub state we should be in
+ if ($sCommand eq 'file') { $sSubState = 'DOXYFILE'; }
+ elsif ($sCommand eq 'class') { $sSubState = 'DOXYCLASS'; }
+ elsif ($sCommand eq 'package') { $sSubState = 'DOXYCLASS'; }
+ elsif ($sCommand eq 'function') { $sSubState = 'DOXYFUNCTION'; }
+ elsif ($sCommand eq 'method') { $sSubState = 'DOXYMETHOD'; }
+ elsif ($sCommand eq 'attr') { $sSubState = 'DOXYATTR'; }
+ elsif ($sCommand eq 'var') { $sSubState = 'DOXYATTR'; }
+ else { $sSubState = 'DOXYCOMMENT'; }
+ $logger->debug("Substate is now $sSubState");
+
+ if ($sSubState eq 'DOXYFILE' )
+ {
+ $logger->debug("Processing a Doxygen file object");
+ # We need to remove the command line from this block
+ shift @aBlock;
+ $self->{'_hData'}->{'filename'}->{'details'} = $self->_RemovePerlCommentFlags(\@aBlock);
+ }
+ elsif ($sSubState eq 'DOXYCLASS')
+ {
+ $logger->debug("Processing a Doxygen class object");
+ #my $sClassName = $sOptions;
+ my $sClassName = $sOptions || $sClassName;
+ my $classDef = $self->_SwitchClass($sClassName);
+ # We need to remove the command line from this block
+ shift @aBlock;
+ #$self->{'_hData'}->{'class'}->{$sClassName}->{'details'} = $self->_RemovePerlCommentFlags(\@aBlock);
+ $classDef->{'details'} = $self->_RemovePerlCommentFlags(\@aBlock);
+ }
+ elsif ($sSubState eq 'DOXYCOMMENT')
+ {
+ $logger->debug("Processing a Doxygen class object");
+ # For extra comment blocks we need to add the command and option line back to the front of the array
+ my $sMethodName = $self->{'_sCurrentMethodName'};
+ if (defined $sMethodName)
+ {
+ $self->{'_hData'}->{'class'}->{$sClassName}->{'subroutines'}->{$sMethodName}->{'comments'} .= "\n";
+ $self->{'_hData'}->{'class'}->{$sClassName}->{'subroutines'}->{$sMethodName}->{'comments'} .= $self->_RemovePerlCommentFlags(\@aBlock);
+ $self->{'_hData'}->{'class'}->{$sClassName}->{'subroutines'}->{$sMethodName}->{'comments'} .= "\n";
+ }
+ else
+ {
+ $self->{'_hData'}->{'class'}->{$sClassName}->{'comments'} .= "\n";
+ $self->{'_hData'}->{'class'}->{$sClassName}->{'comments'} .= $self->_RemovePerlCommentFlags(\@aBlock);
+ $self->{'_hData'}->{'class'}->{$sClassName}->{'comments'} .= "\n";
+ }
+ }
+ elsif ($sSubState eq 'DOXYATTR')
+ {
+ # Process the doxygen header first then loop through the rest of the comments
+ #my ($sState, $sAttrName, $sComments) = ($sOptions =~ /(?:(public|private)\s+)?([\$@%\*][\w:]+)\s+(.*)/);
+ my ($sState, $modifiers, $modifiersLoop, $modifiersChoice, $fullSpec, $typeSpec, $typeName, $typeLoop, $pointerLoop, $typeCode, $sAttrName, $sComments) = ($sOptions =~ /(?:(public|protected|private)\s+)?(((static|const)\s+)*)((((\w+::)*\w+(\s+|\s*\*+\s+|\s+\*+\s*))|)([\$@%\*])([\w:]+))\s+(.*)/);
+ if (defined $sAttrName)
+ {
+ my $attrDef = $self->{'_hData'}->{'class'}->{$sClassName}->{'attributes'}->{$sAttrName} ||= {};
+ if ($typeName)
+ {
+ $attrDef->{'type'} = $typeName;
+ }
+ else
+ {
+ $attrDef->{'type'} = $self->_ConvertTypeCode($typeCode);
+ }
+ if (defined $sState)
+ {
+ $attrDef->{'state'} = $sState;
+ }
+ if (defined $sComments)
+ {
+ $attrDef->{'comments'} = $sComments;
+ }
+ if (defined $modifiers)
+ {
+ $attrDef->{'modifiers'} = $modifiers;
+ }
+ ## We need to remove the command line from this block
+ shift @aBlock;
+ $attrDef->{'details'} = $self->_RemovePerlCommentFlags(\@aBlock);
+ push(@{$self->GetCurrentClass()->{attributeorder}}, $sAttrName);
+ }
+ else
+ {
+ $self->ReportError("invalid syntax for attribute: $sOptions\n");
+ }
+ } # End DOXYATTR
+ elsif ($sSubState eq 'DOXYFUNCTION' || $sSubState eq 'DOXYMETHOD')
+ {
+ # Process the doxygen header first then loop through the rest of the comments
+ $sOptions =~ /^(.*?)\s*\(\s*(.*?)\s*\)/;
+ $sOptions = $1;
+ my $sParameters = $2;
+
+ my @aOptions;
+ my $state;
+ my $sMethodName;
+
+ if (defined $sOptions)
+ {
+ @aOptions = split(/\s+/, $sOptions);
+ # State = Public/Private
+ if ($aOptions[0] eq "public" || $aOptions[0] eq "private" || $aOptions[0] eq "protected")
+ {
+ $state = shift @aOptions;
+ }
+ $sMethodName = pop(@aOptions);
+ }
+
+ if ($sSubState eq "DOXYFUNCTION" && !grep(/^static$/, @aOptions))
+ {
+ unshift(@aOptions, "static");
+ }
+
+ unless (defined $sMethodName)
+ {
+ # If we are already in a subroutine and a user uses sloppy documentation and only does
+ # #**@method in side the subroutine, then lets pull the current method name from the object.
+ # If there is no method defined there, we should die.
+ if (defined $self->{'_sCurrentMethodName'}) { $sMethodName = $self->{'_sCurrentMethodName'}; }
+ else { die "Missing method name in $sCommand syntax"; }
+ }
+
+ # If we are not yet in a subroutine, lets keep track that we are now processing a subroutine and its name
+ unless (defined $self->{'_sCurrentMethodName'}) { $self->{'_sCurrentMethodName'} = $sMethodName; }
+
+ if (defined $sParameters) { $sParameters = $self->_ConvertParameters($sParameters); }
+
+ $self->{'_hData'}->{'class'}->{$sClassName}->{'subroutines'}->{$sMethodName}->{'returntype'} = join(" ", @aOptions);
+ $self->{'_hData'}->{'class'}->{$sClassName}->{'subroutines'}->{$sMethodName}->{'type'} = $sCommand;
+ if (defined $state)
+ {
+ $self->{'_hData'}->{'class'}->{$sClassName}->{'subroutines'}->{$sMethodName}->{'state'} = $state;
+ }
+ $self->{'_hData'}->{'class'}->{$sClassName}->{'subroutines'}->{$sMethodName}->{'parameters'} = $sParameters;
+ # We need to remove the command line from this block
+ shift @aBlock;
+ $self->{'_hData'}->{'class'}->{$sClassName}->{'subroutines'}->{$sMethodName}->{'details'} = $self->_RemovePerlCommentFlags(\@aBlock);
+
+ } # End DOXYFUNCTION || DOXYMETHOD
+}
+
+sub _RemovePerlCommentFlags
+{
+ #** @method private _RemovePerlCommentFlags ($aBlock)
+ # This method will remove all of the comment marks "#" for our output to Doxygen. If the line is
+ # flagged for verbatim then lets not do anything.
+ # @param aBlock - required array_ref (doxygen comment as an array of code lines)
+ # @retval sBlockDetails - string (doxygen comments in one long string)
+ #*
+ my $self = shift;
+ my $aBlock = shift;
+ my $logger = $self->GetLogger($self);
+ $logger->debug("### Entering _RemovePerlCommentFlags ###");
+
+ my $sBlockDetails = "";
+ my $iInVerbatimBlock = 0;
+ foreach my $line (@$aBlock)
+ {
+ # Lets check for a verbatim command option like '# @verbatim'
+ if ($line =~ /^\s*#\s*\@verbatim/)
+ {
+ $logger->debug("Found verbatim command");
+ # We need to remove the comment marker from the '# @verbaim' line now since it will not be caught later
+ $line =~ s/^\s*#\s*/ /;
+ $iInVerbatimBlock = 1;
+ }
+ elsif ($line =~ /^\s*#\s*\@endverbatim/)
+ {
+ $logger->debug("Found endverbatim command");
+ $iInVerbatimBlock = 0;
+ }
+ # Lets remove any doxygen command initiator
+ $line =~ s/^\s*#\*\*\s*//;
+ # Lets remove any doxygen command terminators
+ $line =~ s/^\s*#\*\s*//;
+ # Lets remove all of the Perl comment markers so long as we are not in a verbatim block
+ # if ($iInVerbatimBlock == 0) { $line =~ s/^\s*#+//; }
+ # Patch from Sebastian Rose to address spacing and indentation in code examples
+ if ($iInVerbatimBlock == 0) { $line =~ s/^\s*#\s?//; }
+ $logger->debug("code: $line");
+ # Patch from Mihai MOJE to address method comments all on the same line.
+ $sBlockDetails .= $line . "<br>";
+ #$sBlockDetails .= $line;
+ }
+ $sBlockDetails =~ s/^([ \t]*\n)+//s;
+ chomp($sBlockDetails);
+ if ($sBlockDetails)
+ {
+ $sBlockDetails =~ s/^/ \*/gm;
+ $sBlockDetails .= "\n";
+ }
+ return $sBlockDetails;
+}
+
+sub _ConvertToOfficialDoxygenSyntax
+{
+ #** @method private _ConvertToOfficialDoxygenSyntax ($line)
+ # This method will check the current line for various unsupported doxygen comment blocks and convert them
+ # to the type we support, '#** @command'. The reason for this is so that we do not need to add them in
+ # every if statement throughout the code.
+ # @param line - required string (line of code)
+ # @retval line - string (line of code)
+ #*
+ my $self = shift;
+ my $line = shift;
+ my $logger = $self->GetLogger($self);
+ $logger->debug("### Entering _ConvertToOfficialDoxygenSyntax ###");
+
+ # This will match "## @command" and convert it to "#** @command"
+ if ($line =~ /^\s*##\s+\@/) { $line =~ s/^(\s*)##(\s+\@)/$1#\*\*$2/; }
+ else {
+ $logger->debug('Nothing to do, did not find any ## @');
+ }
+ return $line;
+}
+
+sub _ConvertTypeCode
+{
+ #** @method private _ConvertTypeCode($code)
+ # This method will change the $, @, and %, etc to written names so that Doxygen does not have a problem with them
+ # @param code
+ # required prefix of variable
+ #*
+ my $self = shift;
+ my $code = shift;
+ my $logger = $self->GetLogger($self);
+ $logger->debug("### Entering _ConvertParameters ###");
+
+ # Lets clean up the parameters list so that it will work with Doxygen
+ $code =~ s/\$\$/scalar_ref/g;
+ $code =~ s/\@\$/array_ref/g;
+ $code =~ s/\%\$/hash_ref/g;
+ $code =~ s/\$/scalar/g;
+ $code =~ s/\@/array/g;
+ $code =~ s/\%/hash/g;
+
+ return $code;
+}
+
+sub _ConvertParameters
+{
+ #** @method private _ConvertParameters ()
+ # This method will change the $, @, and %, etc to written names so that Doxygen does not have a problem with them
+ # @param sParameters - required string (variable parameter to change)
+ #*
+ my $self = shift;
+ my $sParameters = shift;
+ my $logger = $self->GetLogger($self);
+ $logger->debug("### Entering _ConvertParameters ###");
+
+ # Lets clean up the parameters list so that it will work with Doxygen
+ $sParameters =~ s/\$\$/scalar_ref /g;
+ $sParameters =~ s/\@\$/array_ref /g;
+ $sParameters =~ s/\%\$/hash_ref /g;
+ $sParameters =~ s/\$/scalar /g;
+ $sParameters =~ s/\@/array /g;
+ $sParameters =~ s/\%/hash /g;
+
+ return $sParameters;
+}
+
+=head1 NAME
+
+Doxygen::Filter::Perl - A perl code pre-filter for Doxygen
+
+=head1 DESCRIPTION
+
+The Doxygen::Filter::Perl module is designed to provide support for documenting
+perl scripts and modules to be used with the Doxygen engine. We plan on
+supporting most Doxygen style comments and POD (plain old documentation) style
+comments. The Doxgyen style comment blocks for methods/functions can be inside
+or outside the method/function. Doxygen::Filter::Perl is hosted at
+http://perldoxygen.sourceforge.net/
+
+=head1 USAGE
+
+Install Doxygen::Filter::Perl via CPAN or from source. If you install from
+source then do:
+
+ perl Makefile.PL
+ make
+ make install
+
+Make sure that the doxygen-filter-perl script was copied from this project into
+your path somewhere and that it has RX permissions. Example:
+
+ /usr/local/bin/doxygen-filter-perl
+
+Copy over the Doxyfile file from this project into the root directory of your
+project so that it is at the same level as your lib directory. This file will
+have all of the presets needed for documenting Perl code. You can edit this
+file with the doxywizard tool if you so desire or if you need to change the
+lib directory location or the output location (the default output is ./doc).
+Please see the Doxygen manual for information on how to configure the Doxyfile
+via a text editor or with the doxywizard tool.
+Example:
+
+ /home/jordan/workspace/PerlDoxygen/trunk/Doxyfile
+ /home/jordan/workspace/PerlDoxygen/trunk/lib/Doxygen/Filter/Perl.pm
+
+Once you have done this you can simply run the following from the root of your
+project to document your Perl scripts or methods. Example:
+
+ /home/jordan/workspace/PerlDoxygen/trunk/> doxygen Doxyfile
+
+All of your documentation will be in the ./doc/html/ directory inside of your
+project root.
+
+=head1 DOXYGEN SUPPORT
+
+The following Doxygen style comment is the preferred block style, though others
+are supported and are listed below:
+
+ #**
+ # ........
+ #*
+
+You can also start comment blocks with "##" and end comment blocks with a blank
+line or real code, this allows you to place comments right next to the
+subroutines that they refer to if you wish. A comment block must have
+continuous "#" comment markers as a blank line can be used as a termination
+mark for the doxygen comment block.
+
+In other languages the Doxygen @fn structural indicator is used to document
+subroutines/functions/methods and the parsing engine figures out what is what.
+In Perl that is a lot harder to do so I have added a @method and @function
+structural indicator so that they can be documented seperatly.
+
+=head2 Supported Structural Indicators
+
+ #** @file [filename]
+ # ........
+ #*
+
+ #** @class [class name (ex. Doxygen::Filter::Perl)]
+ # ........
+ #*
+
+ #** @method or @function [public|protected|private] [method-name] (parameters)
+ # ........
+ #*
+
+ #** @attr or @var [public|protected|private] [type] {$%@}[attribute-name] [brief description]
+ # ........
+ #*
+
+ #** @section [section-name] [section-title]
+ # ........
+ #*
+
+ #** @brief [notes]
+ # ........
+ #*
+
+=head2 Support Style Options and Section Indicators
+
+All doxygen style options and section indicators are supported inside the
+structural indicators that we currently support.
+
+=head2 Documenting Subroutines/Functions/Methods
+
+The Doxygen style comment blocks that describe a function or method can
+exist before, after, or inside the subroutine that it is describing. Examples
+are listed below. It is also important to note that you can leave the public/private
+out and the filter will guess based on the subroutine name. The normal convention
+in other languages like C is to have the function/method start with an "_" if it
+is private/protected. We do the same thing here even though there is really no
+such thing in Perl. The whole reason for this is to help users of the code know
+what functions they should call directly and which they should not. The generic
+documentation blocks for functions and methods look like:
+
+ #** @function [public|protected|private] [return-type] function-name (parameters)
+ # @brief A brief description of the function
+ #
+ # A detailed description of the function
+ # @params value [required|optional] [details]
+ # @retval value [details]
+ # ....
+ #*
+
+ #** @method [public|protected|private] [return-type] method-name (parameters)
+ # @brief A brief description of the method
+ #
+ # A detailed description of the method
+ # @params value [required|optional] [details]
+ # @retval value [details]
+ # ....
+ #*
+
+The parameters would normally be something like $foo, @bar, or %foobar. I have
+also added support for scalar, array, and hash references and those would be
+documented as $$foo, @$bar, %$foobar. An example would look this:
+
+ #** @method public ProcessDataValues ($$sFile, %$hDataValues)
+
+=head2 Function / Method Example
+
+ sub test1
+ {
+ #** @method public test1 ($value)
+ # ....
+ #*
+ }
+
+ #** @method public test2 ($value)
+ # ....
+ #*
+ sub test2
+ {
+
+ }
+
+=head1 DATA STRUCTURE
+
+ $self->{'_hData'}->{'filename'}->{'fullpath'} = string
+ $self->{'_hData'}->{'filename'}->{'shortname'} = string
+ $self->{'_hData'}->{'filename'}->{'version'} = string
+ $self->{'_hData'}->{'filename'}->{'details'} = string
+ $self->{'_hData'}->{'includes'} = array
+
+ $self->{'_hData'}->{'class'}->{'classorder'} = array
+ $self->{'_hData'}->{'class'}->{$class}->{'subroutineorder'} = array
+ $self->{'_hData'}->{'class'}->{$class}->{'attributeorder'} = array
+ $self->{'_hData'}->{'class'}->{$class}->{'details'} = string
+ $self->{'_hData'}->{'class'}->{$class}->{'comments'} = string
+
+ $self->{'_hData'}->{'class'}->{$class}->{'subroutines'}->{$method}->{'type'} = string (method / function)
+ $self->{'_hData'}->{'class'}->{$class}->{'subroutines'}->{$method}->{'returntype'} = string (return type)
+ $self->{'_hData'}->{'class'}->{$class}->{'subroutines'}->{$method}->{'state'} = string (public / private)
+ $self->{'_hData'}->{'class'}->{$class}->{'subroutines'}->{$method}->{'parameters'} = string (method / function parameters)
+ $self->{'_hData'}->{'class'}->{$class}->{'subroutines'}->{$method}->{'code'} = string
+ $self->{'_hData'}->{'class'}->{$class}->{'subroutines'}->{$method}->{'length'} = integer
+ $self->{'_hData'}->{'class'}->{$class}->{'subroutines'}->{$method}->{'details'} = string
+ $self->{'_hData'}->{'class'}->{$class}->{'subroutines'}->{$method}->{'comments'} = string
+
+ $self->{'_hData'}->{'class'}->{$class}->{'attributes'}->{$variable}->{'state'} = string (public / private)
+ $self->{'_hData'}->{'class'}->{$class}->{'attributes'}->{$variable}->{'modifiers'} = string
+ $self->{'_hData'}->{'class'}->{$class}->{'attributes'}->{$variable}->{'comments'} = string
+ $self->{'_hData'}->{'class'}->{$class}->{'attributes'}->{$variable}->{'details'} = string
+
+=head1 AUTHOR
+
+Bret Jordan <jordan at open1x littledot org> or <jordan2175 at gmail littledot com>
+
+=head1 LICENSE
+
+Doxygen::Filter::Perl is licensed with an Apache 2 license. See the LICENSE
+file for more details.
+
+=cut
+
+return 1;
diff --git a/lib/Doxygen/Filter/Perl/POD.pm b/lib/Doxygen/Filter/Perl/POD.pm
new file mode 100644
index 0000000..853a665
--- /dev/null
+++ b/lib/Doxygen/Filter/Perl/POD.pm
@@ -0,0 +1,94 @@
+#** @file POD.pm
+# @verbatim
+#####################################################################
+# This program is not guaranteed to work at all, and by using this #
+# program you release the author of any and all liability. #
+# #
+# You may use this code as long as you are in compliance with the #
+# license (see the LICENSE file) and this notice, disclaimer and #
+# comment box remain intact and unchanged. #
+# #
+# Package: Doxygen::Filter::Perl #
+# Class: POD #
+# Description: Methods for prefiltering Perl code for Doxygen #
+# #
+# Written by: Bret Jordan (jordan at open1x littledot org) #
+# Created: 2011-10-13 #
+#####################################################################
+# @endverbatim
+#
+# @copy 2011, Bret Jordan (jordan2175 at gmail.com, jordan at open1x.org)
+# $Id: POD.pm 88 2012-07-07 04:27:35Z jordan2175 $
+#*
+package Doxygen::Filter::Perl::POD;
+
+use 5.8.8;
+use strict;
+use warnings;
+use parent qw(Pod::POM::View::HTML);
+use Log::Log4perl;
+
+our $VERSION = '1.72';
+$VERSION = eval $VERSION;
+
+
+sub view_pod
+{
+ my ($self, $pod) = @_;
+ return $pod->content->present($self);
+}
+
+sub view_head1
+{
+ my ($self, $head1) = @_;
+ my $title = $head1->title->present($self);
+ my $name = $title;
+ $name =~ s/\s/_/g;
+ return "\n\@section $name $title\n" . $head1->content->present($self);
+}
+
+sub view_head2
+{
+ my ($self, $head2) = @_;
+ my $title = $head2->title->present($self);
+ my $name = $title;
+ $name =~ s/\s/_/g;
+ return "\n\@subsection $name $title\n" . $head2->content->present($self);
+}
+
+sub view_seq_code
+{
+ my ($self, $text) = @_;
+ return "\n\@code\n$text\n\@endcode\n";
+}
+
+
+
+
+=head1 NAME
+
+Doxygen::Filter::Perl::POD - A perl code pre-filter for Doxygen
+
+=head1 DESCRIPTION
+
+The Doxygen::Filter::Perl::POD is a helper module for use with Doxygen::Filter::Perl
+and should not be called directly. This class actually overloads some of the methods
+found in Pod::POM::View::HTML and converts their output to be in a Doxygen style that
+Doxygen::Filter::Perl can use. The reason I went this route is Pod::POM appears to
+be well established and pretty good at parsing POD. I thus did not want to reinvent
+the wheel when it appears that this wheel works pretty well. Now this class should
+probably find its way in to the Pod::POM::View tree at some point. But for now it
+is here.
+
+=head1 AUTHOR
+
+Bret Jordan <jordan at open1x littledot org> or <jordan2175 at gmail littledot com>
+
+=head1 LICENSE
+
+This is free software, licensed under the Apache License, Version 2.0.
+See the LICENSE file included with this package for license details.
+
+=cut
+
+return 1;
diff --git a/t/version.t b/t/version.t
new file mode 100644
index 0000000..1f69c0f
--- /dev/null
+++ b/t/version.t
@@ -0,0 +1,101 @@
+#!/usr/bin/perl
+#####################################################################
+# This program is not guaranteed to work at all, and by using this #
+# program you release the author of any and all liability. #
+# #
+# You may use this code as long as you are in compliance with the #
+# license (see the LICENSE file) and this notice, disclaimer and #
+# comment box remain intact and unchanged. #
+# #
+# Package: Doxygen::Filter::Perl #
+# UnitTest: version.t #
+# Description: Unit test and verification for checking VERSIONs #
+# #
+# Written by: Bret Jordan (jordan at open1x littledot org) #
+# Created: 2011-11-07 #
+#####################################################################
+#
+#
+#
+#
+
+use lib "lib/";
+
+use strict;
+use warnings;
+use Doxygen::Filter::Perl;
+use Test::More;
+use Test::Output;
+
+my $test = new Doxygen::Filter::Perl();
+$test->ProcessFile();
+
+
+my @aFileData;
+my $sCorrectValue;
+my $sTestValue;
+
+
+print "\n";
+print "######################################################################\n";
+print "# Version Test 1 #\n";
+print "# Can we create the object #\n";
+print "######################################################################\n";
+ok( defined $test, 'verify new() created an object' );
+
+
+
+print "\n";
+print "######################################################################\n";
+print "# Version Test 2 #\n";
+print "# our \$VERSION = '0.99_21' #\n";
+print "# Should get a version of 0.99_21 #\n";
+print "######################################################################\n";
+ at aFileData = (
+ '',
+ 'our $VERSION = \'0.99_21\';',
+ '$VERSION = eval $VERSION;',
+ ''
+);
+$test->{'_aRawFileData'} = \@aFileData;
+$test->ProcessFile();
+$sCorrectValue = '0.99_21';
+$sTestValue = $test->{'_hData'}->{'filename'}->{'version'};
+is("$sTestValue", "$sCorrectValue", "verify VERSION string of $sCorrectValue was parsed correctly" );
+&RESET_TEST;
+
+
+
+print "\n";
+print "######################################################################\n";
+print "# Version Test 3 #\n";
+print "# use version; our \$VERSION = qv('0.3.1') #\n";
+print "# Should get a version of 0.3.1 #\n";
+print "######################################################################\n";
+ at aFileData = (
+ '',
+ 'use version; our $VERSION = qv(\'0.3.1\');',
+ ''
+);
+$test->{'_aRawFileData'} = \@aFileData;
+$test->ProcessFile();
+$sCorrectValue = '0.3.1';
+$sTestValue = $test->{'_hData'}->{'filename'}->{'version'};
+is("$sTestValue", "$sCorrectValue", "verify VERSION string of $sCorrectValue was parsed correctly" );
+&RESET_TEST;
+
+
+
+done_testing();
+
+sub RESET_TEST
+{
+ @aFileData = undef;
+ $sCorrectValue = undef;
+ $sTestValue = undef;
+}
+
+
+
+
+
--
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-perl/packages/libdoxygen-filter-perl.git
More information about the Pkg-perl-cvs-commits
mailing list