- updated for packages
authorMartin Willi <martin@strongswan.org>
Fri, 25 Nov 2005 07:00:02 +0000 (07:00 -0000)
committerMartin Willi <martin@strongswan.org>
Fri, 25 Nov 2005 07:00:02 +0000 (07:00 -0000)
Source/charon/documentation.DoxyFile

index 2d3c2bd..f9716e1 100644 (file)
-# Doxyfile 1.4.2
+# Doxyfile 1.4.1-KDevelop
 
 #---------------------------------------------------------------------------
 # Project related configuration options
 #---------------------------------------------------------------------------
-
-PROJECT_NAME = IKEv2 for Linux strongSwan
-
-PROJECT_NUMBER = 1.0
-
-OUTPUT_DIRECTORY = /tmp/doc
-
-CREATE_SUBDIRS = NO
-
-OUTPUT_LANGUAGE = English
-
-USE_WINDOWS_ENCODING = NO
-
-BRIEF_MEMBER_DESC = YES
-
-REPEAT_BRIEF = YES
-
-ABBREVIATE_BRIEF = 
-
-ALWAYS_DETAILED_SEC = NO
-
-INLINE_INHERITED_MEMB = NO
-
-FULL_PATH_NAMES = YES
-
-STRIP_FROM_PATH = 
-
-STRIP_FROM_INC_PATH = 
-
-SHORT_NAMES = NO
-
-JAVADOC_AUTOBRIEF = YES
-
+PROJECT_NAME           = "strongSwan II"
+PROJECT_NUMBER         = 1.0
+OUTPUT_DIRECTORY       = doc
+CREATE_SUBDIRS         = NO
+OUTPUT_LANGUAGE        = English
+USE_WINDOWS_ENCODING   = NO
+BRIEF_MEMBER_DESC      = YES
+REPEAT_BRIEF           = YES
+ABBREVIATE_BRIEF       = 
+ALWAYS_DETAILED_SEC    = NO
+INLINE_INHERITED_MEMB  = NO
+FULL_PATH_NAMES        = YES
+STRIP_FROM_PATH        = 
+STRIP_FROM_INC_PATH    = 
+SHORT_NAMES            = NO
+JAVADOC_AUTOBRIEF      = YES
 MULTILINE_CPP_IS_BRIEF = NO
-
-DETAILS_AT_TOP = NO
-
-INHERIT_DOCS = YES
-
-DISTRIBUTE_GROUP_DOC = NO
-
-SEPARATE_MEMBER_PAGES = NO
-
-TAB_SIZE = 8
-
-ALIASES = 
-
-OPTIMIZE_OUTPUT_FOR_C = YES
-
-OPTIMIZE_OUTPUT_JAVA = NO
-
-SUBGROUPING = YES
-
+DETAILS_AT_TOP         = YES
+INHERIT_DOCS           = YES
+DISTRIBUTE_GROUP_DOC   = NO
+TAB_SIZE               = 1
+ALIASES                = 
+OPTIMIZE_OUTPUT_FOR_C  = YES
+OPTIMIZE_OUTPUT_JAVA   = NO
+SUBGROUPING            = NO
 #---------------------------------------------------------------------------
 # Build related configuration options
 #---------------------------------------------------------------------------
-
-EXTRACT_ALL = YES
-
-EXTRACT_PRIVATE = YES
-
-EXTRACT_STATIC = YES
-
-EXTRACT_LOCAL_CLASSES = YES
-
-EXTRACT_LOCAL_METHODS = YES
-
-HIDE_UNDOC_MEMBERS = YES
-
-HIDE_UNDOC_CLASSES = YES
-
-HIDE_FRIEND_COMPOUNDS = NO
-
-HIDE_IN_BODY_DOCS = NO
-
-INTERNAL_DOCS = NO
-
-CASE_SENSE_NAMES = YES
-
-HIDE_SCOPE_NAMES = NO
-
-SHOW_INCLUDE_FILES = YES
-
-INLINE_INFO = YES
-
-SORT_MEMBER_DOCS = YES
-
-SORT_BRIEF_DOCS = NO
-
-SORT_BY_SCOPE_NAME = NO
-
-GENERATE_TODOLIST = NO
-
-GENERATE_TESTLIST = NO
-
-GENERATE_BUGLIST = YES
-
-GENERATE_DEPRECATEDLIST = YES
-
-ENABLED_SECTIONS = 
-
-MAX_INITIALIZER_LINES = 30
-
-SHOW_USED_FILES = YES
-
-SHOW_DIRECTORIES = YES
-
-FILE_VERSION_FILTER = 
-
+EXTRACT_ALL            = YES
+EXTRACT_PRIVATE        = NO
+EXTRACT_STATIC         = NO
+EXTRACT_LOCAL_CLASSES  = YES
+EXTRACT_LOCAL_METHODS  = YES
+HIDE_UNDOC_MEMBERS     = YES
+HIDE_UNDOC_CLASSES     = YES
+HIDE_FRIEND_COMPOUNDS  = NO
+HIDE_IN_BODY_DOCS      = NO
+INTERNAL_DOCS          = NO
+CASE_SENSE_NAMES       = YES
+HIDE_SCOPE_NAMES       = NO
+SHOW_INCLUDE_FILES     = YES
+INLINE_INFO            = YES
+SORT_MEMBER_DOCS       = YES
+SORT_BRIEF_DOCS        = NO
+SORT_BY_SCOPE_NAME     = YES
+GENERATE_TODOLIST      = YES
+GENERATE_TESTLIST      = NO
+GENERATE_BUGLIST       = YES
+GENERATE_DEPRECATEDLIST= YES
+ENABLED_SECTIONS       = 
+MAX_INITIALIZER_LINES  = 30
+SHOW_USED_FILES        = YES
+SHOW_DIRECTORIES       = NO
+FILE_VERSION_FILTER    = 
 #---------------------------------------------------------------------------
 # configuration options related to warning and progress messages
 #---------------------------------------------------------------------------
-
-QUIET = NO
-
-WARNINGS = YES
-
-WARN_IF_UNDOCUMENTED = YES
-
-WARN_IF_DOC_ERROR = YES
-
-WARN_NO_PARAMDOC = NO
-
-WARN_FORMAT = "$file:$line: $text"
-
-WARN_LOGFILE = 
-
+QUIET                  = NO
+WARNINGS               = YES
+WARN_IF_UNDOCUMENTED   = YES
+WARN_IF_DOC_ERROR      = YES
+WARN_NO_PARAMDOC       = NO
+WARN_FORMAT            = "$file:$line: $text"
+WARN_LOGFILE           = 
 #---------------------------------------------------------------------------
 # configuration options related to the input files
 #---------------------------------------------------------------------------
-
-INPUT = ./
-
-FILE_PATTERNS = *.c *.h
-
-RECURSIVE = YES
-
-EXCLUDE = testcases
-
-EXCLUDE_SYMLINKS = NO
-
-EXCLUDE_PATTERNS = 
-
-EXAMPLE_PATH = 
-
-EXAMPLE_PATTERNS = 
-
-EXAMPLE_RECURSIVE = NO
-
-IMAGE_PATH = 
-
-INPUT_FILTER = 
-
-FILTER_PATTERNS = 
-
-FILTER_SOURCE_FILES = NO
-
+INPUT                  = ./
+FILE_PATTERNS          = *.h
+RECURSIVE              = YES
+EXCLUDE                = testcases
+EXCLUDE_SYMLINKS       = NO
+EXCLUDE_PATTERNS       = 
+EXAMPLE_PATH           = 
+EXAMPLE_PATTERNS       = 
+EXAMPLE_RECURSIVE      = NO
+IMAGE_PATH             = 
+INPUT_FILTER           = 
+FILTER_PATTERNS        = 
+FILTER_SOURCE_FILES    = NO
 #---------------------------------------------------------------------------
 # configuration options related to source browsing
 #---------------------------------------------------------------------------
-
-SOURCE_BROWSER = NO
-
-INLINE_SOURCES = NO
-
-STRIP_CODE_COMMENTS = YES
-
+SOURCE_BROWSER         = NO
+INLINE_SOURCES         = NO
+STRIP_CODE_COMMENTS    = YES
 REFERENCED_BY_RELATION = NO
-
-REFERENCES_RELATION = NO
-
-VERBATIM_HEADERS = NO
-
+REFERENCES_RELATION    = NO
+VERBATIM_HEADERS       = YES
 #---------------------------------------------------------------------------
 # configuration options related to the alphabetical class index
 #---------------------------------------------------------------------------
-
-ALPHABETICAL_INDEX = NO
-
-COLS_IN_ALPHA_INDEX = 5
-
-IGNORE_PREFIX = 
-
+ALPHABETICAL_INDEX     = NO
+COLS_IN_ALPHA_INDEX    = 5
+IGNORE_PREFIX          = 
 #---------------------------------------------------------------------------
 # configuration options related to the HTML output
 #---------------------------------------------------------------------------
-
-GENERATE_HTML = YES
-
-HTML_OUTPUT = html
-
-HTML_FILE_EXTENSION = .html
-
-HTML_HEADER = 
-
-HTML_FOOTER = 
-
-HTML_STYLESHEET = 
-
-HTML_ALIGN_MEMBERS = YES
-
-GENERATE_HTMLHELP = NO
-
-CHM_FILE = 
-
-HHC_LOCATION = 
-
-GENERATE_CHI = NO
-
-BINARY_TOC = NO
-
-TOC_EXPAND = NO
-
-DISABLE_INDEX = NO
-
-ENUM_VALUES_PER_LINE = 4
-
-GENERATE_TREEVIEW = YES
-
-TREEVIEW_WIDTH = 250
-
+GENERATE_HTML          = YES
+HTML_OUTPUT            = .
+HTML_FILE_EXTENSION    = .html
+HTML_HEADER            = 
+HTML_FOOTER            = 
+HTML_STYLESHEET        = 
+HTML_ALIGN_MEMBERS     = YES
+GENERATE_HTMLHELP      = NO
+CHM_FILE               = 
+HHC_LOCATION           = 
+GENERATE_CHI           = NO
+BINARY_TOC             = NO
+TOC_EXPAND             = NO
+DISABLE_INDEX          = NO
+ENUM_VALUES_PER_LINE   = 1
+GENERATE_TREEVIEW      = YES
+TREEVIEW_WIDTH         = 250
 #---------------------------------------------------------------------------
 # configuration options related to the LaTeX output
 #---------------------------------------------------------------------------
-
-GENERATE_LATEX = NO
-
-LATEX_OUTPUT = latex
-
-LATEX_CMD_NAME = latex
-
-MAKEINDEX_CMD_NAME = makeindex
-
-COMPACT_LATEX = NO
-
-PAPER_TYPE = a4wide
-
-EXTRA_PACKAGES = 
-
-LATEX_HEADER = 
-
-PDF_HYPERLINKS = NO
-
-USE_PDFLATEX = NO
-
-LATEX_BATCHMODE = NO
-
-LATEX_HIDE_INDICES = NO
-
+GENERATE_LATEX         = NO
+LATEX_OUTPUT           = latex
+LATEX_CMD_NAME         = latex
+MAKEINDEX_CMD_NAME     = makeindex
+COMPACT_LATEX          = NO
+PAPER_TYPE             = a4wide
+EXTRA_PACKAGES         = 
+LATEX_HEADER           = 
+PDF_HYPERLINKS         = NO
+USE_PDFLATEX           = NO
+LATEX_BATCHMODE        = NO
+LATEX_HIDE_INDICES     = NO
 #---------------------------------------------------------------------------
 # configuration options related to the RTF output
 #---------------------------------------------------------------------------
-
-GENERATE_RTF = NO
-
-RTF_OUTPUT = rtf
-
-COMPACT_RTF = NO
-
-RTF_HYPERLINKS = NO
-
-RTF_STYLESHEET_FILE = 
-
-RTF_EXTENSIONS_FILE = 
-
+GENERATE_RTF           = NO
+RTF_OUTPUT             = rtf
+COMPACT_RTF            = NO
+RTF_HYPERLINKS         = NO
+RTF_STYLESHEET_FILE    = 
+RTF_EXTENSIONS_FILE    = 
 #---------------------------------------------------------------------------
 # configuration options related to the man page output
 #---------------------------------------------------------------------------
-
-GENERATE_MAN = YES
-
-MAN_OUTPUT = man
-
-MAN_EXTENSION = .3
-
-MAN_LINKS = YES
-
+GENERATE_MAN           = NO
+MAN_OUTPUT             = man
+MAN_EXTENSION          = .3
+MAN_LINKS              = YES
 #---------------------------------------------------------------------------
 # configuration options related to the XML output
 #---------------------------------------------------------------------------
-
-GENERATE_XML = NO
-
-XML_OUTPUT = xml
-
-XML_SCHEMA = 
-
-XML_DTD = 
-
-XML_PROGRAMLISTING = YES
-
+GENERATE_XML           = NO
+XML_OUTPUT             = xml
+XML_SCHEMA             = 
+XML_DTD                = 
+XML_PROGRAMLISTING     = YES
 #---------------------------------------------------------------------------
 # configuration options for the AutoGen Definitions output
 #---------------------------------------------------------------------------
-
-GENERATE_AUTOGEN_DEF = NO
-
+GENERATE_AUTOGEN_DEF   = NO
 #---------------------------------------------------------------------------
 # configuration options related to the Perl module output
 #---------------------------------------------------------------------------
-
-GENERATE_PERLMOD = NO
-
-PERLMOD_LATEX = NO
-
-PERLMOD_PRETTY = YES
-
+GENERATE_PERLMOD       = NO
+PERLMOD_LATEX          = NO
+PERLMOD_PRETTY         = YES
 PERLMOD_MAKEVAR_PREFIX = 
-
 #---------------------------------------------------------------------------
 # Configuration options related to the preprocessor   
 #---------------------------------------------------------------------------
-
-ENABLE_PREPROCESSING = YES
-
-MACRO_EXPANSION = NO
-
-EXPAND_ONLY_PREDEF = NO
-
-SEARCH_INCLUDES = YES
-
-INCLUDE_PATH = 
-
-INCLUDE_FILE_PATTERNS = 
-
-PREDEFINED = LEAK_DETECTIVE
-
-EXPAND_AS_DEFINED = 
-
-SKIP_FUNCTION_MACROS = YES
-
+ENABLE_PREPROCESSING   = YES
+MACRO_EXPANSION        = YES
+EXPAND_ONLY_PREDEF     = NO
+SEARCH_INCLUDES        = YES
+INCLUDE_PATH           = 
+INCLUDE_FILE_PATTERNS  = 
+PREDEFINED             = LEAK_DETECTIVE
+EXPAND_AS_DEFINED      = 
+SKIP_FUNCTION_MACROS   = YES
 #---------------------------------------------------------------------------
 # Configuration::additions related to external references   
 #---------------------------------------------------------------------------
-
-TAGFILES = 
-
-GENERATE_TAGFILE = 
-
-ALLEXTERNALS = NO
-
-EXTERNAL_GROUPS = YES
-
-PERL_PATH = /usr/bin/perl
-
+TAGFILES               = 
+GENERATE_TAGFILE       = 
+ALLEXTERNALS           = NO
+EXTERNAL_GROUPS        = YES
+PERL_PATH              = /usr/bin/perl
 #---------------------------------------------------------------------------
 # Configuration options related to the dot tool   
 #---------------------------------------------------------------------------
-
-CLASS_DIAGRAMS = YES
-
-HIDE_UNDOC_RELATIONS = YES
-
-HAVE_DOT = NO
-
-CLASS_GRAPH = YES
-
-COLLABORATION_GRAPH = YES
-
-GROUP_GRAPHS = YES
-
-UML_LOOK = NO
-
-TEMPLATE_RELATIONS = NO
-
-INCLUDE_GRAPH = YES
-
-INCLUDED_BY_GRAPH = YES
-
-CALL_GRAPH = NO
-
-GRAPHICAL_HIERARCHY = YES
-
-DIRECTORY_GRAPH = YES
-
-DOT_IMAGE_FORMAT = png
-
-DOT_PATH = 
-
-DOTFILE_DIRS = 
-
-MAX_DOT_GRAPH_WIDTH = 1024
-
-MAX_DOT_GRAPH_HEIGHT = 1024
-
-MAX_DOT_GRAPH_DEPTH = 0
-
-DOT_TRANSPARENT = NO
-
-DOT_MULTI_TARGETS = NO
-
-GENERATE_LEGEND = YES
-
-DOT_CLEANUP = YES
-
+CLASS_DIAGRAMS         = YES
+HIDE_UNDOC_RELATIONS   = YES
+HAVE_DOT               = NO
+CLASS_GRAPH            = YES
+COLLABORATION_GRAPH    = YES
+GROUP_GRAPHS           = YES
+UML_LOOK               = NO
+TEMPLATE_RELATIONS     = NO
+INCLUDE_GRAPH          = YES
+INCLUDED_BY_GRAPH      = YES
+CALL_GRAPH             = NO
+GRAPHICAL_HIERARCHY    = YES
+DIRECTORY_GRAPH        = YES
+DOT_IMAGE_FORMAT       = png
+DOT_PATH               = 
+DOTFILE_DIRS           = 
+MAX_DOT_GRAPH_WIDTH    = 1024
+MAX_DOT_GRAPH_HEIGHT   = 1024
+MAX_DOT_GRAPH_DEPTH    = 0
+DOT_TRANSPARENT        = NO
+DOT_MULTI_TARGETS      = NO
+GENERATE_LEGEND        = YES
+DOT_CLEANUP            = YES
 #---------------------------------------------------------------------------
 # Configuration::additions related to the search engine   
 #---------------------------------------------------------------------------
-
-SEARCHENGINE = NO
-
+SEARCHENGINE           = YES