Thread: [Yake-svn] SF.net SVN: yake: [1500] trunk/yake/documentation/api
Status: Beta
Brought to you by:
psyclonist
From: <psy...@us...> - 2006-11-23 22:10:41
|
Revision: 1500 http://svn.sourceforge.net/yake/?rev=1500&view=rev Author: psyclonist Date: 2006-11-23 14:10:30 -0800 (Thu, 23 Nov 2006) Log Message: ----------- set version to 0.6.0dev, added yake/raf to API docs script Modified Paths: -------------- trunk/yake/documentation/api/DoxySfile trunk/yake/documentation/api/docMainPage.h Modified: trunk/yake/documentation/api/DoxySfile =================================================================== --- trunk/yake/documentation/api/DoxySfile 2006-11-18 22:21:57 UTC (rev 1499) +++ trunk/yake/documentation/api/DoxySfile 2006-11-23 22:10:30 UTC (rev 1500) @@ -4,9 +4,9 @@ # General configuration options #--------------------------------------------------------------------------- PROJECT_NAME = YAKE -PROJECT_NUMBER = 0.5.0-dev +PROJECT_NUMBER = 0.6.0-dev #INPUT = yake/msg -INPUT = documentation/api yake/base/math yake/base/mpl yake/base/native yake/base/templates yake/base yake/audio yake/data yake/ent yake/file yake/graphics yake/input yake/net yake/object yake/physics yake/prop yake/scripting yake/statemachine yake/msg yake/model +INPUT = documentation/api yake/base/math yake/base/mpl yake/base/native yake/base/templates yake/base yake/audio yake/data yake/ent yake/file yake/graphics yake/input yake/net yake/object yake/physics yake/prop yake/scripting yake/statemachine yake/msg yake/model yapp/raf OUTPUT_DIRECTORY = documentation/api/html GENERATE_DOXYS_HELP = YES HTML_FILE_EXTENSION = .html @@ -214,7 +214,7 @@ # - # This could be handy for archiving the generated documentation or # - # if some version control system is used. # - -# - PROJECT_NUMBER = 0.5.0-dev +# - PROJECT_NUMBER = 0.6.0-dev # - # - # The INPUT tag can be used to specify the files and/or directories that contain # - # documented source files. You may enter file names like "myfile.cpp" or Modified: trunk/yake/documentation/api/docMainPage.h =================================================================== --- trunk/yake/documentation/api/docMainPage.h 2006-11-18 22:21:57 UTC (rev 1499) +++ trunk/yake/documentation/api/docMainPage.h 2006-11-23 22:10:30 UTC (rev 1500) @@ -1,6 +1,6 @@ -/** \mainpage "YAKE 0.5.0dev API" +/** \mainpage "YAKE 0.6.0dev API" -!!! YAKE 0.5.0dev API Documentation +!!! YAKE 0.6.0dev API Documentation !! What is this? This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <psy...@us...> - 2007-03-28 09:47:17
|
Revision: 1690 http://svn.sourceforge.net/yake/?rev=1690&view=rev Author: psyclonist Date: 2007-03-28 02:47:16 -0700 (Wed, 28 Mar 2007) Log Message: ----------- Modified Paths: -------------- trunk/yake/documentation/api/DoxySfile trunk/yake/documentation/api/Doxyfile Modified: trunk/yake/documentation/api/DoxySfile =================================================================== --- trunk/yake/documentation/api/DoxySfile 2007-03-27 22:24:58 UTC (rev 1689) +++ trunk/yake/documentation/api/DoxySfile 2007-03-28 09:47:16 UTC (rev 1690) @@ -1,12 +1,11 @@ -# DoxySfile 0.90b ShortConfig -- Do not remove or edit this line please -- +# DoxySfile 0.95 ShortConfig -- Do not remove or edit this line please -- #--------------------------------------------------------------------------- # General configuration options #--------------------------------------------------------------------------- PROJECT_NAME = YAKE PROJECT_NUMBER = 0.6.0-dev -#INPUT = yake/msg -INPUT = documentation/api yake/base/math yake/base/mpl yake/base/native yake/base/templates yake/base yake/audio yake/data yake/ent yake/file yake/graphics yake/input yake/net yake/netsvc yake/object yake/physics yake/prop yake/scripting yake/statemachine yake/msg yake/model yapp/raf +INPUT = documentation/api yake/audio yake/base/math yake/base/mpl yake/base/native yake/base/templates yake/base yake/bindings.lua yake/common yake/data yake/ent yake/file yake/graphics yake/gui yake/gui_adapter yake/gui_addons yake/input yake/loader yake/model yake/msg yake/net yake/netsvc yake/netrepsvc yake/object yake/physics yake/prop yake/property yake/raf yake/scripting yake/statemachine yake/task yake/vehicle yake/yappbase OUTPUT_DIRECTORY = documentation/api/html GENERATE_DOXYS_HELP = YES HTML_FILE_EXTENSION = .html @@ -30,6 +29,7 @@ SEARCH_FUNCTIONS = YES SEARCH_VARIABLES = YES SEARCH_TYPEDEFS_ETC = YES +AUTO_KEYWORD_LIMIT = 2 #--------------------------------------------------------------------------- # Specify what is included in the output #--------------------------------------------------------------------------- @@ -42,6 +42,8 @@ EXTRACT_LOCAL_CLASSES = YES HIDE_UNDOC_NAMESPACES = NO HIDE_UNDOC_CLASSES = NO +HIDE_UNDOC_STRUCTS = NO +HIDE_UNDOC_UNIONS = NO HIDE_UNDOC_FUNCTIONS = NO HIDE_UNDOC_VARIABLES = NO HIDE_UNDOC_ENUMS = NO @@ -65,9 +67,10 @@ HIDE_CLASS_METHODS_IN_OVERVIEW = NO CONCATENATE_DECL_AND_DEFINITION_DOC = YES #--------------------------------------------------------------------------- -# Customize layout for pure text projects (ie containing no code) +# Controlling the DocParser (wiki style parser) #--------------------------------------------------------------------------- PAGE_DOCUMENTATION_MODE = NO +ENABLE_HARD_SOFT_LINE_BREAKS = YES #--------------------------------------------------------------------------- # Options to control how the input is parsed #--------------------------------------------------------------------------- @@ -76,15 +79,17 @@ ALIASES = ENABLED_SECTIONS = IGNORE_CLASS_PREFIX = +AUTO_BRIEF_ENDS_AT_FIRST_NEWLINE = YES #--------------------------------------------------------------------------- # configuration options related to warning and progress messages #--------------------------------------------------------------------------- MESSAGE_LEVEL_SCREEN = Messages Warnings -OUTPUT_PREFIX_SCREEN = Warnings Errors OUTPUT_PATTERNS_SCREEN = Progress Preprocessor Scanner Generator Docparser Dot Definition Configfile Undocumented Unknown -MESSAGE_SCREEN_LOGFILE = +OUTPUT_PREFIX_LEVEL_SCREEN = Warnings Errors +OUTPUT_PREFIX_PATTERNS_SCREEN = MESSAGE_LEVEL_HTML_FILE = Messages Warnings Errors Debug OUTPUT_PATTERNS_HTML_FILE = Progress Preprocessor Scanner Generator Docparser Dot Definition Configfile Undocumented Unknown +MESSAGE_SCREEN_LOGFILE = QUIET = YES #--------------------------------------------------------------------------- # Configuration options related to the input files @@ -115,6 +120,7 @@ EXPAND_COLLAPSE_SECTIONS = YES EXPAND_COLLAPSE_TABLE_SECTIONS_ONLY = YES CENTER_ALIGN_IMAGES = NO +OPTIMIZE_OUTPUT_FOR_C = NO #--------------------------------------------------------------------------- # Configuration options related to Left Menu layout #--------------------------------------------------------------------------- @@ -127,6 +133,7 @@ LEFT_MENU_DIRECTORIES = YES LEFT_MENU_PAGES = YES LEFT_MENU_CLASSES = YES +LEFT_MENU_STRUCTS = YES LEFT_MENU_FUNCTIONS = NO LEFT_MENU_MACROS = NO LEFT_MENU_DEFINES = NO @@ -189,1100 +196,1291 @@ -# - # DoxySfile 0.90b LongConfig -- Do not remove or edit this line please -- +# - # DoxySfile 0.90b ShortConfig -- Do not remove or edit this line please -- # - -# - # This file describes the settings to be used by the documentation system -# - # DoxyS (www.DoxyS.org) for a project -# - # -# - # All text after a 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 (" ") -# - # - #--------------------------------------------------------------------------- # - # General configuration options # - #--------------------------------------------------------------------------- -# - -# - # The PROJECT_NAME tag is a single word (or a sequence of words surrounded -# - # by quotes) that should identify the project. -# - # - PROJECT_NAME = YAKE -# - -# - # 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 = 0.6.0-dev -# - -# - # The INPUT tag can be 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. -# - -# - INPUT = ../../yake ../../yapp -# - -# - # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) -# - # base path where the generated documentation will be put. -# - # If a relative path is entered, it will be relative to the location -# - # where DoxyS was started. If left blank 'doxys_doc' will be used. -# - -# - OUTPUT_DIRECTORY = doxys_docs/ -# - -# - # If the GENERATE_DOXYS_HELP tag is set to YES, DoxyS will -# - # generate help pages for DoxyS itself along with to the project documentation -# - +# - #INPUT = yake/msg +# - INPUT = documentation/api yake/audio yake/base/math yake/base/mpl yake/base/native yake/base/templates yake/base yake/bindings.lua yake/common yake/data yake/ent yake/file yake/graphics yake/gui yake/gui_adapter yake/gui_addons yake/input yake/loader yake/model yake/msg yake/net yake/netsvc yake/netrepsvc yake/object yake/physics yake/prop yake/property yake/raf yake/scripting yake/statemachine yake/task yake/vehicle yake/yappbase +# - OUTPUT_DIRECTORY = documentation/api/html # - GENERATE_DOXYS_HELP = YES -# - -# - # The HTML_FILE_EXTENSION tag can be used to specify the file extension for -# - # each generated HTML page (for example: .htm,.php,.asp). If it is left blank -# - # DoxyS will generate files with .html extension. -# - # - HTML_FILE_EXTENSION = .html -# - -# - # The CUSTOM_DIR tag is used to specify where the custom directory is. -# - # The custom directory is used to place a $#logo.gif#$, $#logo.jpg#$ or -# - # $#logo.png#$. This logo file is used on all the pages. -# - # A style sheet file can be placed here if you want a different setup then the default. -# - # Run DoxyS, copy the style sheet file from the common dir and you are ready to go. -# - # - CUSTOM_DIR = -# - -# - # The SERVER_STATISTICS tag is used to specify where the server statistics file is. -# - # If left blank, server statistics is turned off. -# - # To use server statistics, you will need a script on a server to collect the data -# - # from the static HTML pages. Script can be found at http://www.doxys.dk under Download. -# - # Make your own script and database. -# - # Make a database with these filds: -# - # Id, Definitiontype, Pagename, Pagetype, Projectname, Date, Requestpage -# - # A script that can receive these posted arguments: -# - # projectname, definitiontype, pagename, pagetypeand add the date and HTTP_REFERER your self when putting it all into the database. -# - # - SERVER_STATISTICS = -# - -# - # The HTML_HELP_SERVER_PATH tag is used to specify where the root of the -# - # HTML files will be placed on the server. Used when generating XML-file -# - # for integration with MS.NET. -# - # - HTML_HELP_SERVER_PATH = -# - -# - # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct -# - # DoxyS to hide any special comment blocks from generated source code -# - # fragments. Normal C and C++ comments will always remain visible. -# - # - STRIP_CODE_COMMENTS = YES -# - # - #--------------------------------------------------------------------------- # - # Special options (rarely changed) # - #--------------------------------------------------------------------------- -# - -# - # If the DELETE_OUTPUT_DIRECTORY tag is set to YES, then the output directory will be -# - # deleted before writing the new output. This can save time in some cases -# - # - DELETE_OUTPUT_DIRECTORY = YES -# - -# - # If the MS_DOT_NET_INTEGRATION tag is set to YES then a XML file -# - # for use with MS Visual Studio .Net will be placed in 'OUT_DIR' -# - # -# - # How to: Taken from Microsofts homepage. -# - # Save the file as 'HelpTest2.xml' in Microsoft Visual Studio .NET/Common7/IDE/HTML/XMLLinks/[LCID], where [LCID] depends upon your language, such as English or French. For example, the English LCID is 1033. -# - # If it is not already open, display the Dynamic Help window by pressing CTRL+F1. -# - # Notice that two new links appear in the Dynamic Help window. One is under a link group called 'Samples' and is called 'Sample: Intro to Visual Studio .NET' and another link called 'Direct Link to MSDN' is under a custom link group called 'Custom Help.' -# - # -# - # Creating custom link groups allows you to have special categories in which to display your links. Professors and other academic instructors might, for example, create a custom link group called 'Homework' or 'CS101 Projects.' They could then put links to their topics under the custom link group. IT managers and group leads might want to create a custom link group, for example, named 'Coding Policies' that contains links to Help topics on corporate coding policy. For more information, see Creating Custom Link Groups. -# - # - MS_DOT_NET_INTEGRATION = NO -# - -# - # The MS_DOT_NET_INTEGRATION_PATH tag is used to specify where the MS DOT NET integration xml is to be put. -# - # Usaualy "/Program Files/Microsoft Visual Studio .NET 2003/Common7/IDE/HTML/XMLLinks/1033" -# - # If left empty the xml will be put on documentation root. -# - # - MS_DOT_NET_INTEGRATION_PATH = -# - -# - # If GENERATE_HTMLHELP1 tag is set to YES, then HtmlHelp1 project(hhp) will be generated. -# - # Output will be put on documentation root. -# - # - GENERATE_HTMLHELP1 = NO -# - -# - # If GENERATE_STATISTICS tag is set to YES, there will be generated a statistics page. -# - # Output will be in documentation root/common/statistics. -# - # Information, warnings, errors and statistics can be found here. -# - -# - GENERATE_STATISTICS = YES -# - +# - GENERATE_STATISTICS = NO # - #--------------------------------------------------------------------------- # - # Search page options # - #--------------------------------------------------------------------------- -# - -# - # If the CREATE_SEARCHPAGE tag is set to YES DoxyS will create -# - # a searchpage. WARNING, if the project is very large (+500.000 lines), -# - # it is recomended to reduce the searchpage by adjusting some of the -# - # following options. Other options include using #Mozilla FireFox# browser -# - # which seems to execute the Java search-script 3-4 times faster than Opera -# - # and Internet Explorer. -# - # - CREATE_SEARCHPAGE = YES -# - -# - # If set to YES DoxyS will include data to search in all the -# - # brief descriptions for all types and pages. The brief description -# - # is to the first full stop of the description. In case the project -# - # is very large setting this option to $NO$ could improve search speed -# - # significantly. -# - # - SEARCH_BRIEF_DESCRIPTION = YES -# - -# - # If set to YES DoxyS will include data to search in all the functions -# - # and macros in the project. -# - # - SEARCH_FUNCTIONS = YES -# - -# - # If set to YES DoxyS will include data to search in all the variables -# - # in the project. Tis includes member varibles as well as global variables, -# - # but not automatic variables. -# - # - SEARCH_VARIABLES = YES -# - -# - # If set to YES DoxyS will include data to search in all the typedefs, -# - # enumerations, enum values, defines etc. Basically all C++ entities which -# - # are {not{ covered by the aboveoptions. -# - # - SEARCH_TYPEDEFS_ETC = YES -# - # - #--------------------------------------------------------------------------- # - # Specify what is included in the output # - #--------------------------------------------------------------------------- -# - -# - # If set to YES DoxyS will create Documentation for files. Documentation for files -# - # features #included files# and #included by diagrams#, if $INCLUDE_GRAPH$ and -# - # $INCLUDED_BY_GRAPH$ are set to YES. -# - # - CREATE_DOC_FOR_FILES = YES -# - -# - # If the CREATE_SOURCECODE_FOR_FILES tag is set to YES and CREATE_DOC_FOR_FILES is set to YES -# - # DoxyS will create the tab 'Source' that holds the sourcecode for the hole file. -# - # - CREATE_SOURCECODE_FOR_FILES = NO -# - -# - # If the CREATE_SOURCECODE_FOR_MEMBERS tag is set to YES -# - # DoxyS will create the tab 'Source' that holds the sourcecode for the member. -# - -# - CREATE_SOURCECODE_FOR_MEMBERS = YES -# - -# - # If set to YES all private members of a class will be included in the documentation. -# - -# - EXTRACT_PRIVATE = YES -# - -# - # If the EXTRACT_PROTECTED tag is set to YES all protected members of a class -# - # will be included in the documentation. -# - +# - CREATE_SOURCECODE_FOR_MEMBERS = NO +# - EXTRACT_PRIVATE = NO # - EXTRACT_PROTECTED = YES -# - -# - # If the EXTRACT_STATIC tag is set to YES all static members of a file -# - # will be included in the documentation. -# - # - EXTRACT_STATIC = YES -# - -# - # 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. -# - # - EXTRACT_LOCAL_CLASSES = YES -# - -# - # If the HIDE_UNDOC_NAMESPACES tag is set to YES, DoxyS will hide all undocumented namespaces. -# - # - HIDE_UNDOC_NAMESPACES = NO -# - -# - # If the HIDE_UNDOC_CLASSES tag is set to YES, DoxyS will hide all -# - # undocumented classes that are normally visible in the class hierarchy. -# - # If set to NO (the default) these classes will be included in the various -# - # overviews. This option has no effect if EXTRACT_ALL is enabled. -# - # - HIDE_UNDOC_CLASSES = NO -# - -# - # If set to YES, DoxyS will hide all undocumented functions -# - # inside classes, files or namespaces. -# - # - HIDE_UNDOC_FUNCTIONS = NO -# - -# - # If set to YES, DoxyS will hide all undocumented variables -# - # inside classes, files or namespaces. -# - # - HIDE_UNDOC_VARIABLES = NO -# - -# - # If set to YES, DoxyS will hide all undocumented enummerations -# - # inside classes, files or namespaces. -# - # - HIDE_UNDOC_ENUMS = NO -# - -# - # If set to YES, DoxyS will hide all undocumented enum values -# - # inside classes, files or namespaces. -# - # - HIDE_UNDOC_ENUM_VALUES = NO -# - -# - # If set to YES, DoxyS will hide all undocumented typedefs -# - # inside classes, files or namespaces. -# - # - HIDE_UNDOC_TYPEDEFS = NO -# - -# - # If set to YES, DoxyS will hide all undocumented defines. -# - # - HIDE_UNDOC_MACROS = NO -# - -# - # If set to YES, DoxyS will hide all undocumented defines. -# - # - HIDE_UNDOC_DEFINES = YES -# - -# - # The GENERATE_TODOLIST tag can be used to enable (YES) or -# - # disable (NO) the todo list. This list is created by putting odo -# - # commands in the documentation. -# - # - GENERATE_TODOLIST = 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. -# - # - 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. -# - # - GENERATE_DEPRECATEDLIST = YES -# - # - #--------------------------------------------------------------------------- # - # Customize how the documentation is generated # - #--------------------------------------------------------------------------- -# - -# - # If the MEMBER_SAME_FILE_RELATE_TO_CLASSES tag is set to YES DoxyS will relate all free -# - # functions, types, defines etc. To the class(es) defined in the same file. -# - # - MEMBER_SAME_FILE_RELATE_TO_CLASSES = YES -# - -# - # If the MEMBER_SAME_FILE_RELATE_TO_STRUCTS tag is set to YES DoxyS will relate all free -# - # functions, types, defines etc. To the struct(s) defined in the same file. -# - # - MEMBER_SAME_FILE_RELATE_TO_STRUCTS = NO -# - -# - # If the FULL_PATH_NAMES tag is set to YES then DoxyS 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. -# - # - FULL_PATH_NAMES = NO -# - -# - # If the FULL_PATH_NAMES tag is set to YES then 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. It is allowed to use relative paths in the argument list. -# - # - STRIP_FROM_PATH = -# - -# - # The INTERNAL_DOCS tag determines if documentation -# - # that is typed after a \internal command is included. If the tag is set -# - # to NO (the default) then the documentation will be excluded. -# - # Set it to YES to include the internal documentation. -# - # - INTERNAL_DOCS = NO -# - -# - # Determines whehter documentation -# - # that is typed after a \todo 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. -# - # - TODO_DOCS = YES -# - -# - # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented -# - # member inherits the documentation from any documented member that it -# - # reimplements. -# - # - INHERIT_DOCS = YES -# - -# - # If set to true then member functions (methods) -# - # of classes will be hidden from all functions tab. -# - # - HIDE_CLASS_METHODS_IN_OVERVIEW = NO -# - -# - # For functions: If set to true then the documentation from the -# - # declaration (header-file) and from the implementation/definition . -# - # (cpp-file) are concatenated. Brief description from header is -# - # concatenated with brief description from cpp-file and same with. -# - # main documentation. If set to NO, only one of the two are used -# - # prefering the one from the definition/cpp-file. -# - # - CONCATENATE_DECL_AND_DEFINITION_DOC = YES -# - # - #--------------------------------------------------------------------------- # - # Customize layout for pure text projects (ie containing no code) # - #--------------------------------------------------------------------------- -# - -# - # Mainly for projects that contains no source code, but only pages and directories. -# - # The overview, info classes etc. tabs on mainpage and directories will be disabled. -# - # Other tabs are not affected, so it's still possible to have source code in the project, -# - # but mainpage and directories have only Description tabs displayed. -# - # - PAGE_DOCUMENTATION_MODE = NO -# - # - #--------------------------------------------------------------------------- # - # Options to control how the input is parsed # - #--------------------------------------------------------------------------- -# - -# - # If the HIDE_IN_BODY_DOCS tag is set to YES, DoxyS will hide any -# - # documentation blocks found inside the body of a function. -# - # If set to NO (the default) these blocks will be appended to the -# - # function's detailed documentation block. -# - -# - HIDE_IN_BODY_DOCS = NO -# - -# - # The TAB_SIZE tag can be used to set the number of spaces in a tab. -# - # DoxyS uses this value to replace tabs by spaces in code fragments. -# - +# - HIDE_IN_BODY_DOCS = YES # - TAB_SIZE = 4 -# - -# - # This tag can be used to specify a number of aliases that acts -# - # 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 = -# - -# - # The ENABLED_SECTIONS tag can be used to enable conditional -# - # documentation sections, marked by \if sectionname ... \endif. -# - # - ENABLED_SECTIONS = -# - -# - # 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_CLASS_PREFIX tag can be used to specify one or more prefixes that -# - # should be ignored while generating the index headers. -# - # - IGNORE_CLASS_PREFIX = -# - # - #--------------------------------------------------------------------------- # - # configuration options related to warning and progress messages # - #--------------------------------------------------------------------------- -# - -# - # The message level that will be printed on the stdout. -# - # Errors will always be printed on stderr. -# - # Options avalible: -# - # Messages Warnings Debug -# - # - MESSAGE_LEVEL_SCREEN = Messages Warnings -# - -# - # Prefix messages for the screen. -# - # Options avalible: -# - # Messages Warnings Errors Debug -# - # - OUTPUT_PREFIX_SCREEN = Warnings Errors -# - -# - # Patterns for the output. -# - # Options avalible: -# - # Progress Preprocessor Scanner Generator Docparser Dot Definition Configfile Undocumented Unknown -# - # - OUTPUT_PATTERNS_SCREEN = Progress Preprocessor Scanner Generator Docparser Dot Definition Configfile Undocumented Unknown -# - -# - # The MESSAGE_SCREEN_LOGFILE tag can be used to specify a file to which all messages -# - # that is shown on the screen should be written. If left blank, no output to log file. -# - # Use MESSAGE_LEVEL_SCREEN and OUTPUT_PATTERNS_SCREEN to reduce the number of messages. -# - # - MESSAGE_SCREEN_LOGFILE = -# - -# - # The message level that will be writen in the HTML statistics. -# - # options avalible: -# - # Messages Warnings Errors Debug -# - # - MESSAGE_LEVEL_HTML_FILE = Messages Warnings Errors Debug -# - -# - # Patterns for the output. -# - # Options avalible: -# - # Progress Preprocessor Scanner Generator Docparser Dot Definition Configfile Undocumented Unknown -# - # - OUTPUT_PATTERNS_HTML_FILE = Progress Preprocessor Scanner Generator Docparser Dot Definition Configfile Undocumented Unknown -# - -# - # With the QUIET tag on, only Progress and Errors will be printed to the screen. -# - # Anything else will be as a ' . '. -# - # Possible values are YES and NO. If left blank NO is used. -# - # - QUIET = YES -# - # - #--------------------------------------------------------------------------- # - # Configuration options related to the input files # - #--------------------------------------------------------------------------- -# - -# - # The IGNORE_FILE_NAME tag can be used to specify a possible textfile in each -# - # directory which is searched for files/subdirs to exclude. The default value -# - # is 'DoxyS.ignore'. It works like '.cvsignore'. The file is a simple textfile listing -# - # one file/subdir per line relative to the directory of the 'DoxyS.ignore' file. -# - # Like this: -# - # #$file_to_ignore.cpp$# -# - # - IGNORE_FILE_NAME = DoxyS.ignore -# - -# - # If the value of the INPUT tag contains directories, you can use the -# - # FILE_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 the following patterns are tested: -# - # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp -# - # *.h++ *.idl *.odl *.cs *.page *.dir *.dxd *.doc -# - # - FILE_PATTERNS = *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp *.h++ *.idl *.odl *.cs *.page *.dir *.dxd *.doc -# - -# - # The RECURSIVE tag can be used to turn specify whether or not subdirectories -# - # should be searched for input files as well. Possible values are YES and NO. -# - # If left blank YES is used. -# - -# - RECURSIVE = YES -# - -# - # The EXCLUDE tag can be used to specify files and/or directories that should -# - # 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. -# - -# - EXCLUDE = doxys_docs/ -# - -# - # The EXCLUDE_SYMLINKS tag can be used select whether or not files or directories -# - # that are symbolic links (a Unix filesystem feature) are excluded from the input. -# - +# - RECURSIVE = NO +# - EXCLUDE = yake/reflection/ yake/samples # - 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. -# - # - EXCLUDE_PATTERNS = -# - -# - # If the example is not found relatively to current directory, -# - # then try to prepend the EXAMPLE_PATH to see if the example is found here! -# - # - EXAMPLE_PATH = -# - -# - # If the image is not found relatively to current directory, -# - # then try to prepend the IMAGE_PATH to see if the image is found here! -# - # - IMAGE_PATH = -# - -# - # The INPUT_FILTER tag can be used to specify a program that DoxyS should -# - # invoke to filter for each input file. DoxyS 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. DoxyS will then use the output that the filter program writes -# - # to standard output. -# - # - INPUT_FILTER = -# - -# - # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using -# - # INPUT_FILTER) will be used to filter the input files when producing source -# - # files to browse. -# - # - FILTER_SOURCE_FILES = NO -# - # - #--------------------------------------------------------------------------- # - # Configuration options related to the HTML layout # - #--------------------------------------------------------------------------- -# - -# - # The NAVIGATION_CHAR_LENGTH tag is the maximum of charters there must be -# - # before we are cutting -# - # This is done to prevent the left menu from taking op to much space -# - # - NAVIGATION_CHAR_LENGTH = 25 -# - -# - # If the number of entries in an overview table exceeds this number, then the -# - # the table will be shown in compact mode. Compact mode means that the table -# - # will contain COLS_IN_OVERVIEW_TABLES coloumns in each row and only the definitions -# - # name will be shown. The brief description will be be shown via mouse over effect. -# - # - LIMIT_COMPACT_IN_OVERVIEW_TABLES = 100 -# - -# - # Number of coloumns in all the overview tables in case some of them -# - # contains so many elements that they need to swich to compact mode. -# - # - COLS_IN_OVERVIEW_TABLES = 4 -# - -# - # If the number of entries in an overview table exceeds this number, then the -# - # the an alphabetical index will be generated. -# - # - LIMIT_ALFA_INDEX_IN_OVERVIEW_TABLES = 200 -# - -# - # The COMPACT_CHAR_LENGTH tag is the maximum of charters there must be -# - # before we are cutting the name in compact mode -# - # This is done to prevent the name from being to long -# - # - COMPACT_CHAR_LENGTH = 25 -# - -# - # Enables the info icon in non compact mode (ie. tables with brief description). -# - # A mouse over will be shown with same type of info as on diagrams. Brief, public members etc. -# - # - INFO_ON_OVERVIEW_TABLES_NORMAL = YES -# - -# - # Enables the info icon in compact mode (ie. tables with no brief description). -# - # A mouse over will be shown with same type of info as on diagrams. Brief, public members etc. -# - # - INFO_ON_OVERVIEW_TABLES_COMPACT = YES -# - -# - # If true the brief description is included in the header of the description. -# - # If both this tag and INCLUDE_BRIEF_IN_DESCRIPTION are set to NO then brief -# - # description will }not} appear on the decription pages. -# - # - INCLUDE_BRIEF_IN_HEADER = YES -# - -# - # If true the brief description is repeated in the description section. -# - # If both this tag and INCLUDE_BRIEF_IN_HEADER are set to NO then brief -# - # description will }not} appear on the decription pages. -# - # - INCLUDE_BRIEF_IN_DESCRIPTION = YES -# - -# - # If true the desciption will not contain type info.Ex:(Page),(Class),(Namespace). -# - # - HIDE_TYPE_ON_DESCRIPTION = NO -# - -# - # Enables the collapse / expand icons on the description page. -# - # All sections can now be collapsed. See also EXPAND_COLLAPSE_TABLE_SECTIONS_ONLY -# - # - EXPAND_COLLAPSE_SECTIONS = YES -# - -# - # Enables the collapse / expand icons on syntax, parameters etc. -# - # This tag depends on EXPAND_COLLAPSE_SECTIONS is set to YES. -# - # If this is set to true, then only syntax/parameters, reimplements etc. -# - # sections will have expand collapse icons. Description, todo, etc. -# - # }cannot} be collapsed. -# - # - EXPAND_COLLAPSE_TABLE_SECTIONS_ONLY = YES -# - -# - # If set to YES, then included images (and their captions) are centered. -# - # Otherwise the images and captions will be left-aligned. -# - # - CENTER_ALIGN_IMAGES = NO -# - # - #--------------------------------------------------------------------------- # - # Configuration options related to Left Menu layout # - #--------------------------------------------------------------------------- -# - -# - # If set to YES then left menu will be generated. -# - # If set to NO leftmemu and logo will not be included. -# - # This option disables all left menus in all types of pages and ignores the other SHOW_LEFT_MENU_XXXX. -# - # - SHOW_LEFT_MENU = YES -# - -# - # If set to YES then left menu will be generated for main page. -# - # If set to NO leftmemu and logo will not be included -# - # - SHOW_LEFT_MENU_MAINDIR = YES -# - -# - # If set to YES then left menu will be generated for search pages. -# - # If set to NO leftmemu and logo will not be included -# - # - SHOW_LEFT_MENU_SEARCH = YES -# - -# - # If set to YES then left menu will be generated for search pages. -# - # If set to NO leftmemu and logo will not be included -# - # - SHOW_LEFT_MENU_DIRECTORY = YES -# - -# - # If set to YES then left menu will be generated for the rest of documentation pages (not above). -# - # If set to NO leftmemu and logo will not be included -# - # - SHOW_LEFT_MENU_DOC = YES -# - -# - # If set to YES and SHOW_LEFT_MENU set to yes then the logo will be displayed. -# - # - SHOW_LOGO = YES -# - -# - # If set to YES directories will be shown on left menu. -# - # - LEFT_MENU_DIRECTORIES = YES -# - -# - # If set to YES pages will be shown on left menu. -# - # - LEFT_MENU_PAGES = YES -# - -# - # If set to YES classes will be shown on left menu. -# - # - LEFT_MENU_CLASSES = YES -# - -# - # If set to YES functions will be shown on left menu. -# - # - LEFT_MENU_FUNCTIONS = NO -# - -# - # If set to YES macros will be shown on left menu. -# - # - LEFT_MENU_MACROS = NO -# - -# - # If set to YES defines will be shown on left menu. -# - # - LEFT_MENU_DEFINES = NO -# - -# - # If set to YES attributes will be shown on left menu. -# - # - LEFT_MENU_ATTRIBUTES = NO -# - -# - # If set to YES types will be shown on left menu. -# - # - LEFT_MENU_TYPES = NO -# - -# - # If set to YES units will be shown on left menu. -# - # - LEFT_MENU_UNITS = YES -# - -# - # If set to YES statistics will be shown on left menu. -# - # - LEFT_MENU_STATISTICS = YES -# - -# - # If set to YES, a link to statistics will be on the main page. -# - # If set to NO then locate the statistics under the common directory. -# - # - STATISTICS_LINK_ON_MAIN_PAGE = YES -# - # - #--------------------------------------------------------------------------- # - # Configuration options related to header and footer layout # - #--------------------------------------------------------------------------- -# - -# - # Mainly for projects that contains no source code, but only pages and directories. -# - # The header part of pages and directories will be disabled if set to true. -# - # This setting can also be used in projects containing code as it's not -# - # dependent on PAGE_DOCUMENTATION_MODE. -# - # - HIDE_HEADER_ON_DIRS_AND_PAGES = NO -# - -# - # Mainly for projects that contains no source code, but only pages and directories. -# - # The footer part of pages and directories will be disabled if set to true. -# - # This setting can also be used in projects containing code as it's not -# - # dependent on PAGE_DOCUMENTATION_MODE. -# - # - HIDE_FOOTER_ON_DIRS_AND_PAGES = NO -# - -# - # The header part will be disabled if set to true. -# - # If set to yes you may also whant to set HIDE_HEADER_ON_DIRS_AND_PAGES to yes -# - # - HIDE_HEADER_ON_CLASS_AND_MEMBERS = NO -# - -# - # The footer part will be disabled if set to true. -# - # If set to yes you may also whant to set HIDE_FOOTER_ON_DIRS_AND_PAGES to yes -# - # - HIDE_FOOTER_ON_CLASS_AND_MEMBERS = NO -# - -# - # The header part will be disabled if set to true. -# - # If set to yes you may also whant to set HIDE_HEADER_ON_DIRS_AND_PAGES to yes -# - # - HIDE_HEADER_ON_UNITS = NO -# - -# - # The footer part will be disabled if set to true. -# - # If set to yes you may also whant to set HIDE_FOOTER_ON_DIRS_AND_PAGES to yes -# - # - HIDE_FOOTER_ON_UNITS = NO -# - # - #--------------------------------------------------------------------------- # - # Configuration options related to the preprocessor # - #--------------------------------------------------------------------------- -# - -# - # If the ENABLE_PREPROCESSING tag is set to YES (the default) DoxyS will -# - # evaluate all C-preprocessor directives found in the sources and include -# - # files. -# - # - ENABLE_PREPROCESSING = YES -# - -# - # If the MACRO_EXPANSION tag is set to YES DoxyS 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). -# - # - MACRO_EXPANSION = YES -# - -# - # 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_PREDEFINED tags. -# - # - EXPAND_ONLY_PREDEF = NO -# - -# - # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files -# - # in the INCLUDE_PATH (see below) will be search if a $\include$ command is found. -# - -# - SEARCH_INCLUDES = YES -# - -# - # 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. -# - +# - SEARCH_INCLUDES = NO # - 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. -# - # - 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 -# - # 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. -# - # - 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. -# - # - EXPAND_AS_DEFINED = -# - -# - # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then -# - # DoxyS's preprocessor will remove all 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. -# - # - SKIP_FUNCTION_MACROS = YES -# - # - #--------------------------------------------------------------------------- # - # Configuration options related to the dot tool # - #--------------------------------------------------------------------------- -# - -# - # If set to YES then DoxyS will assume the dot tool is -# - # available from the path. This tool is part of Graphviz, 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. -# - # - ENABLE_DOT_GRAPHS = YES -# - -# - # The tag DOT_PATH 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 on the path. -# - # - DOT_PATH = -# - -# - # If the CLASS_DIAGRAMS tag is set to YES (the default) DoxyS will -# - # generate a inheritance diagram for classes with base or -# - # super classes. Setting the tag to NO turns the diagrams off. Note that this -# - # option is superceded by the ENABLE_DOT_GRAPHS option below. This is only a fallback. It is -# - # recommended to install and use dot, since it yields more powerful graphs. -# - # - CLASS_DIAGRAMS = YES -# - -# - # 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. -# - # - HIDE_UNDOC_RELATIONS = YES -# - -# - # If the CLASS_GRAPH and ENABLE_DOT_GRAPHS tags are set to YES then DoxyS -# - # will generate a graph for each documented class showing the direct and -# - # indirect inheritance relations. Setting this tag to YES will force the -# - # the CLASS_DIAGRAMS tag to NO. -# - # - CLASS_GRAPH = YES -# - -# - # If the COLLABORATION_GRAPH and ENABLE_DOT_GRAPHS tags are set to YES then DoxyS -# - # 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. -# - # - COLLABORATION_GRAPH = YES -# - -# - # If the UML_LOOK tag is set to YES DoxyS will generate inheritance and -# - # collaboration diagrams in a style similiar to the OMG's Unified Modeling -# - # Language. -# - # - UML_LOOK = NO -# - -# - # If set to YES, the inheritance and collaboration graphs will show the -# - # relations between templates and their instances. -# - # - TEMPLATE_RELATIONS = YES -# - -# - # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and ENABLE_DOT_GRAPHS -# - # tags are set to YES then DoxyS will generate a graph for each documented -# - # file showing the direct and indirect include dependencies of the file with -# - # other documented files. -# - # - INCLUDE_GRAPH = YES -# - -# - # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and -# - # ENABLE_DOT_GRAPHS tags are set to YES then DoxyS will generate a graph for each -# - # documented header file showing the documented files that directly or -# - # indirectly include this file. -# - # - INCLUDED_BY_GRAPH = YES -# - -# - # If the CALL_GRAPH and ENABLE_DOT_GRAPHS tags are set to YES then DoxyS 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. -# - # - CALL_GRAPH = YES -# - -# - # If the CALL_GRAPH and ENABLE_DOT_GRAPHS tags are set to YES then DoxyS will -# - # generate a directory graph for for every directory. -# - # - DIR_GRAPH = YES -# - -# - # If the GRAPHICAL_HIERARCHY and ENABLE_DOT_GRAPHS tags are set to YES then DoxyS -# - # will graphical hierarchy of all classes instead of a textual one. -# - # - GRAPHICAL_HIERARCHY = YES -# - -# - # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images -# - # generated by dot. Possible values are png, jpg, or gif. -# - # If left blank png will be used. -# - # - DOT_IMAGE_FORMAT = png -# - -# - # 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). -# - # - DOTFILE_DIRS = -# - -# - # The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width -# - # (in pixels) of the graphs generated by dot. If a graph becomes larger than -# - # this value, DoxyS will try to truncate the graph, so that it fits within -# - # the specified constraint. Beware that most browsers cannot cope with very -# - # large images. -# - # - MAX_DOT_GRAPH_WIDTH = 1024 -# - -# - # The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height -# - # (in pixels) of the graphs generated by dot. If a graph becomes larger than -# - # this value, DoxyS will try to truncate the graph, so that it fits within -# - # the specified constraint. Beware that most browsers cannot cope with very -# - # large images. -# - # - MAX_DOT_GRAPH_HEIGHT = 1024 -# - -# - # 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 a graph may be further truncated if the graph's image dimensions are -# - # not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH and MAX_DOT_GRAPH_HEIGHT). -# - # If 0 is used for the depth value (the default), the graph is not depth-constrained. -# - # - MAX_DOT_GRAPH_DEPTH = 0 -# - -# - # If set to YES, then all dot images are centered. -# - # Otherwise the images will be left-aligned. -# - # - CENTER_ALIGN_DOT_IMAGES = NO -# - -# - # If the DOT_CLEANUP tag is set to YES (the default) DoxyS will -# - # remove the intermediate dot files that are used to generate -# - # the various graphs. -# - # - DOT_CLEANUP = YES -# - # - #--------------------------------------------------------------------------- # - # Language options # - #--------------------------------------------------------------------------- -# - -# - # The OUTPUT_LANGUAGE tag is used to specify the language in which all -# - # documentation generated by DoxyS is written. DoxyS will use this -# - # information to generate all constant output in the proper language. -# - # The default language is English, other supported languages are: -# - # Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch, -# - # Finnish, French, German, Greek, Hungarian, Italian, Japanese, Japanese-en -# - # (Japanese with English messages), Korean, Norwegian, Polish, Portuguese, -# - # Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian. -# - # - OUTPUT_LANGUAGE = English -# - -# - # This tag can be used to specify the encoding used in the generated output. -# - # The encoding is not always determined by the language that is chosen, -# - # but also whether or not the output is meant for Windows or non-Windows users. -# - # In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES -# - # forces the Windows encoding (this is the default for the Windows binary), -# - # whereas setting the tag to NO uses a Unix-style encoding (the default for -# - # all platforms other than Windows). -# - # - USE_WINDOWS_ENCODING = YES # - # - # - # - # - -# - # - # DoxySfile 0.90b ShortConfig -- Do not remove or edit this line please -- +# - # - # DoxySfile 0.90b LongConfig -- Do not remove or edit this line please -- # - # - +# - # - # This file describes the settings to be used by the documentation system +# - # - # DoxyS (www.DoxyS.org) for a project +# - # - # +# - # - # All text after a 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 (" ") +# - # - # - # - #--------------------------------------------------------------------------- # - # - # General configuration options # - # - #--------------------------------------------------------------------------- -# - # - PROJECT_NAME = DefaultProjectName -# - # - PROJECT_NUMBER = -# - # - INPUT = . +# - # - +# - # - # The PROJECT_NAME tag is a single word (or a sequence of words surrounded +# - # - # by quotes) that should identify the project. +# - # - +# - # - PROJECT_NAME = YAKE +# - # - +# - # - # 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 = 0.6.0-dev +# - # - +# - # - # The INPUT tag can be 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. +# - # - +# - # - INPUT = ../../yake ../../yapp +# - # - +# - # - # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) +# - # - # base path where the generated documentation will be put. +# - # - # If a relative path is entered, it will be relative to the location +# - # - # where DoxyS was started. If left blank 'doxys_doc' will be used. +# - # - # - # - OUTPUT_DIRECTORY = doxys_docs/ +# - # - +# - # - # If the GENERATE_DOXYS_HELP tag is set to YES, DoxyS will +# - # - # generate help pages for DoxyS itself along with to the project documentation +# - # - # - # - GENERATE_DOXYS_HELP = YES +# - # - +# - # - # The HTML_FILE_EXTENSION tag can be used to specify the file extension for +# - # - # each generated HTML page (for example: .htm,.php,.asp). If it is left blank +# - # - # DoxyS will generate files with .html extension. +# - # - # - # - HTML_FILE_EXTENSION = .html +# - # - +# - # - # The CUSTOM_DIR tag is used to specify where the custom directory is. +# - # - # The custom directory is used to place a $#logo.gif#$, $#logo.jpg#$ or +# - # - # $#logo.png#$. This logo file is used on all the pages. +# - # - # A style sheet file can be placed here if you want a different setup then the default. +# - # - # Run DoxyS, copy the style sheet file from the common dir and you are ready to go. +# - # - # - # - CUSTOM_DIR = +# - # - +# - # - # The SERVER_STATISTICS tag is used to specify where the server statistics file is. +# - # - # If left blank, server statistics is turned off. +# - # - # To use server statistics, you will need a script on a server to collect the data +# - # - # from the static HTML pages. Script can be found at http://www.doxys.dk under Download. +# - # - # Make your own script and database. +# - # - # Make a database with these filds: +# - # - # Id, Definitiontype, Pagename, Pagetype, Projectname, Date, Requestpage +# - # - # A script that can receive these posted arguments: +# - # - # projectname, definitiontype, pagename, pagetypeand add the date and HTTP_REFERER your self when putting it all into the database. +# - # - # - # - SERVER_STATISTICS = +# - # - +# - # - # The HTML_HELP_SERVER_PATH tag is used to specify where the root of the +# - # - # HTML files will be placed on the server. Used when generating XML-file +# - # - # for integration with MS.NET. +# - # - # - # - HTML_HELP_SERVER_PATH = +# - # - +# - # - # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct +# - # - # DoxyS to hide any special comment blocks from generated source code +# - # - # fragments. Normal C and C++ comments will always remain visible. +# - # - # - # - STRIP_CODE_COMMENTS = YES +# - # - # - # - #--------------------------------------------------------------------------- # - # - # Special options (rarely changed) # - # - #--------------------------------------------------------------------------- -# - # - DELETE_OUTPUT_DIRECTORY = NO +# - # - +# - # - # If the DELETE_OUTPUT_DIRECTORY tag is set to YES, then the output directory will be +# - # - # deleted before writing the new output. This can save time in some cases +# - # - +# - # - DELETE_OUTPUT_DIRECTORY = YES +# - # - +# - # - # If the MS_DOT_NET_INTEGRATION tag is set to YES then a XML file +# - # - # for use with MS Visual Studio .Net will be placed in 'OUT_DIR' +# - # - # +# - # - # How to: Taken from Microsofts homepage. +# - # - # Save the file as 'HelpTest2.xml' in Microsoft Visual Studio .NET/Common7/IDE/HTML/XMLLinks/[LCID], where [LCID] depends upon your language, such as English or French. For example, the English LCID is 1033. +# - # - # If it is not already open, display the Dynamic Help window by pressing CTRL+F1. +# - # - # Notice that two new links appear in the Dynamic Help window. One is under a link group called 'Samples' and is called 'Sample: Intro to Visual Studio .NET' and another link called 'Direct Link to MSDN' is under a custom link group called 'Custom Help.' +# - # - # +# - # - # Creating custom link groups allows you to have special categories in which to display your links. Professors and other academic instructors might, for example, create a custom link group called 'Homework' or 'CS101 Projects.' They could then put links to their topics under the custom link group. IT managers and group leads might want to create a custom link group, for example, named 'Coding Policies' that contains links to Help topics on corporate coding policy. For more information, see Creating Custom Link Groups. +# - # - # - # - MS_DOT_NET_INTEGRATION = NO +# - # - +# - # - # The MS_DOT_NET_INTEGRATION_PATH tag is used to specify where the MS DOT NET integration xml is to be put. +# - # - # Usaualy "/Program Files/Microsoft Visual Studio .NET 2003/Common7/IDE/HTML/XMLLinks/1033" +# - # - # If left empty the xml will be put on documentation root. +# - # - # - # - MS_DOT_NET_INTEGRATION_PATH = +# - # - +# - # - # If GENERATE_HTMLHELP1 tag is set to YES, then HtmlHelp1 project(hhp) will be generated. +# - # - # Output will be put on documentation root. +# - # - # - # - GENERATE_HTMLHELP1 = NO +# - # - +# - # - # If GENERATE_STATISTICS tag is set to YES, there will be generated a statistics page. +# - # - # Output will be in documentation root/common/statistics. +# - # - # Information, warnings, errors and statistics can be found here. +# - # - # - # - GENERATE_STATISTICS = YES +# - # - # - # - #--------------------------------------------------------------------------- # - # - # Search page options # - # - #--------------------------------------------------------------------------- +# - # - +# - # - # If the CREATE_SEARCHPAGE tag is set to YES DoxyS will create +# - # - # a searchpage. WARNING, if the project is very large (+500.000 lines), +# - # - # it is recomended to reduce the searchpage by adjusting some of the +# - # - # following options. Other options include using #Mozilla FireFox# browser +# - # - # which seems to execute the Java search-script 3-4 times faster than Opera +# - # - # and Internet Explorer. +# - # - # - # - CREATE_SEARCHPAGE = YES +# - # - +# - # - # If set to YES DoxyS will include data to search in all the +# - # - # brief descriptions for all types and pages. The brief description +# - # - # is to the first full stop of the description. In case the project +# - # - # is very large setting this option to $NO$ could improve search speed +# - # - # significantly. +# - # - # - # - SEARCH_BRIEF_DESCRIPTION = YES +# - # - +# - # - # If set to YES DoxyS will include data to search in all the functions +# - # - # and macros in the project. +# - # - # - # - SEARCH_FUNCTIONS = YES +# - # - +# - # - # If set to YES DoxyS will include data to search in all the variables +# - # - # in the project. Tis includes member varibles as well as global variables, +# - # - # but not automatic variables. +# - # - # - # - SEARCH_VARIABLES = YES +# - # - +# - # - # If set to YES DoxyS will include data to search in all the typedefs, +# - # - # enumerations, enum values, defines etc. Basically all C++ entities which +# - # - # are {not{ covered by the aboveoptions. +# - # - # - # - SEARCH_TYPEDEFS_ETC = YES +# - # - # - # - #--------------------------------------------------------------------------- # - # - # Specify what is included in the output # - # - #--------------------------------------------------------------------------- +# - # - +# - # - # If set to YES DoxyS will create Documentation for files. Documentation for files +# - # - # features #included files# and #included by diagrams#, if $INCLUDE_GRAPH$ and +# - # - # $INCLUDED_BY_GRAPH$ are set to YES. +# - # - # - # - CREATE_DOC_FOR_FILES = YES +# - # - +# - # - # If the CREATE_SOURCECODE_FOR_FILES tag is set to YES and CREATE_DOC_FOR_FILES is set to YES +# - # - # DoxyS will create the tab 'Source' that holds the sourcecode for the hole file. +# - # - # - # - CREATE_SOURCECODE_FOR_FILES = NO +# - # - +# - # - # If the CREATE_SOURCECODE_FOR_MEMBERS tag is set to YES +# - # - # DoxyS will create the tab 'Source' that holds the sourcecode for the member. +# - # - # - # - CREATE_SOURCECODE_FOR_MEMBERS = YES +# - # - +# - # - # If set to YES all private members of a class will be included in the documentation. +# - # - # - # - EXTRACT_PRIVATE = YES +# - # - +# - # - # If the EXTRACT_PROTECTED tag is set to YES all protected members of a class +# - # - # will be included in the documentation. +# - # - # - # - EXTRACT_PROTECTED = YES +# - # - +# - # - # If the EXTRACT_STATIC tag is set to YES all static members of a file +# - # - # will be included in the documentation. +# - # - # - # - EXTRACT_STATIC = YES +# - # - +# - # - # 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. +# - # - # - # - EXTRACT_LOCAL_CLASSES = YES +# - # - +# - # - # If the HIDE_UNDOC_NAMESPACES tag is set to YES, DoxyS will hide all undocumented namespaces. +# - # - # - # - HIDE_UNDOC_NAMESPACES = NO +# - # - +# - # - # If the HIDE_UNDOC_CLASSES tag is set to YES, DoxyS will hide all +# - # - # undocumented classes that are normally visible in the class hierarchy. +# - # - # If set to NO (the default... [truncated message content] |