Changeset - 0a5b5b4c20c8
[Not reviewed]
1 1 2
Jan Kaluza - 13 years ago 2012-08-20 13:34:58
hanzz.k@gmail.com
Moved current docs to docs/api
3 files changed with 6 insertions and 5 deletions:
0 comments (0 inline, 0 general)
docs/CMakeLists.txt
Show inline comments
 
configure_file(${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.in ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile @ONLY)
 
add_custom_target(docs doxygen ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR} COMMENT "Generating API documentation with Doxygen" VERBATIM)
 
ADD_SUBDIRECTORY(api)
docs/api/CMakeLists.txt
Show inline comments
 
new file 100644
 
configure_file(${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.in ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile @ONLY)
 
add_custom_target(docs doxygen ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR} COMMENT "Generating API documentation with Doxygen" VERBATIM)
docs/api/Doxyfile.in
Show inline comments
 
file renamed from docs/Doxyfile.in to docs/api/Doxyfile.in
 
# Doxyfile 1.5.8
 

	
 
# This file describes the settings to be used by the documentation system
 
# doxygen (www.doxygen.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 (" ")
 

	
 
#---------------------------------------------------------------------------
 
# 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.
 

	
 
DOXYFILE_ENCODING      = UTF-8
 

	
 
# The PROJECT_NAME tag is a single word (or a sequence of words surrounded 
 
# by quotes) that should identify the project.
 

	
 
PROJECT_NAME           = "@PROJECT_NAME@"
 

	
 
# 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         = "@PROJECT_VERSION@"
 

	
 
# 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 doxygen was started. If left blank the current directory will be used.
 

	
 
OUTPUT_DIRECTORY       = @CMAKE_CURRENT_SOURCE_DIR@/../docs/html
 
OUTPUT_DIRECTORY       = @CMAKE_CURRENT_SOURCE_DIR@/../../docs/api/html
 

	
 
# 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 cause performance problems for the file system.
 

	
 
CREATE_SUBDIRS         = 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. 
 
# The default language is English, other supported languages are: 
 
# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, 
 
# Croatian, Czech, Danish, Dutch, Farsi, Finnish, French, German, Greek, 
 
# Hungarian, Italian, Japanese, Japanese-en (Japanese with English messages), 
 
# Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, Polish, 
 
# Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak, Slovene, 
 
# Spanish, Swedish, and Ukrainian.
 

	
 
OUTPUT_LANGUAGE        = English
 

	
 
# If the BRIEF_MEMBER_DESC tag is set to YES (the default) 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.
 

	
 
BRIEF_MEMBER_DESC      = YES
 

	
 
# If the REPEAT_BRIEF tag is set to YES (the default) 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.
 

	
 
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" "the"
 

	
 
ABBREVIATE_BRIEF       = 
 
@@ -519,97 +519,97 @@ QUIET                  = YES
 

	
 
WARNINGS               = YES
 

	
 
# If WARN_IF_UNDOCUMENTED 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.
 

	
 
WARN_IF_UNDOCUMENTED   = YES
 

	
 
# If WARN_IF_DOC_ERROR 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.
 

	
 
WARN_IF_DOC_ERROR      = YES
 

	
 
# This WARN_NO_PARAMDOC option can be abled to get warnings for 
 
# functions that are documented, but have no documentation for their parameters 
 
# or return value. If set to NO (the default) doxygen will only warn about 
 
# wrong or incomplete parameter documentation, but not about the absence of 
 
# documentation.
 

	
 
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)
 

	
 
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 stderr.
 

	
 
WARN_LOGFILE           = 
 

	
 
#---------------------------------------------------------------------------
 
# configuration options related to the input files
 
#---------------------------------------------------------------------------
 

	
 
# 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                  = @CMAKE_CURRENT_SOURCE_DIR@/../include/transport/
 
INPUT                  = @CMAKE_CURRENT_SOURCE_DIR@/../../include/transport/
 

	
 
# This tag can be used to specify the character encoding of the source files 
 
# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is 
 
# also the default input encoding. 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.
 

	
 
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 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 *.php *.php3 *.inc *.m *.mm *.py *.f90
 

	
 
FILE_PATTERNS          = 
 

	
 
# 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 NO 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                = "_darcs"
 

	
 
# 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.
 

	
 
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, 
 
@@ -718,97 +718,97 @@ REFERENCES_LINK_SOURCE = YES
 
# 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.
 

	
 
USE_HTAGS              = NO
 

	
 
# If the VERBATIM_HEADERS tag is set to YES (the default) 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.
 

	
 
VERBATIM_HEADERS       = YES
 

	
 
#---------------------------------------------------------------------------
 
# 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.
 

	
 
ALPHABETICAL_INDEX     = NO
 

	
 
# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then 
 
# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns 
 
# in which this list will be split (can be a number in the range [1..20])
 

	
 
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 one or more prefixes that 
 
# should be ignored while generating the index headers.
 

	
 
IGNORE_PREFIX          = 
 

	
 
#---------------------------------------------------------------------------
 
# configuration options related to the HTML output
 
#---------------------------------------------------------------------------
 

	
 
# If the GENERATE_HTML tag is set to YES (the default) Doxygen will 
 
# generate HTML output.
 

	
 
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. If left blank `html' will be used as the default path.
 

	
 
HTML_OUTPUT            = @CMAKE_CURRENT_SOURCE_DIR@/../docs/html
 
HTML_OUTPUT            = @CMAKE_CURRENT_SOURCE_DIR@/../../docs/api/html
 

	
 
# 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 
 
# doxygen will generate files with .html extension.
 

	
 
HTML_FILE_EXTENSION    = .html
 

	
 
# The HTML_HEADER tag can be used to specify a personal HTML header for 
 
# each generated HTML page. If it is left blank doxygen will generate a 
 
# standard header.
 

	
 
HTML_HEADER            = 
 

	
 
# The HTML_FOOTER tag can be used to specify a personal HTML footer for 
 
# each generated HTML page. If it is left blank doxygen will generate a 
 
# standard footer.
 

	
 
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 the tag is left blank doxygen 
 
# will generate a default style sheet. Note that doxygen will try to copy 
 
# the style sheet file to the HTML output directory, so don't put your own 
 
# stylesheet in the HTML output directory as well, or it will be erased!
 

	
 
HTML_STYLESHEET        = 
 

	
 
# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, 
 
# files or namespaces will be aligned in HTML using tables. If set to 
 
# NO a bullet list will be used.
 

	
 
HTML_ALIGN_MEMBERS     = 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. For this to work a browser that supports 
 
# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox 
 
# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
 

	
 
HTML_DYNAMIC_SECTIONS  = NO
 

	
 
# 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, 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 
0 comments (0 inline, 0 general)