Doxygen: konfigurační soubor pro generování dokumentace
authorFrantišek Kučera <franta-hg@frantovo.cz>
Thu Apr 09 15:06:48 2009 +0200 (2009-04-09)
changeset 11481514f85b3a
parent 10 18317e52d52b
child 12 7b718fcf981c
Doxygen: konfigurační soubor pro generování dokumentace
c++/POSIXoveFronty/Fronta/fronta.h
c++/POSIXoveFronty/dokumentace/doxygen
     1.1 --- a/c++/POSIXoveFronty/Fronta/fronta.h	Tue Apr 07 23:49:02 2009 +0200
     1.2 +++ b/c++/POSIXoveFronty/Fronta/fronta.h	Thu Apr 09 15:06:48 2009 +0200
     1.3 @@ -9,7 +9,7 @@
     1.4   */
     1.5  class Fronta {
     1.6  public:
     1.7 -    /** Vytvoří frontu (zapisovací umí i číst). */
     1.8 +    /** Vytvoří frontu (název, přijímací, odesílací). */
     1.9      Fronta(char*, bool, bool);
    1.10      Fronta();
    1.11      /** Přidá zprávu do fronty. */
     2.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     2.2 +++ b/c++/POSIXoveFronty/dokumentace/doxygen	Thu Apr 09 15:06:48 2009 +0200
     2.3 @@ -0,0 +1,304 @@
     2.4 +# Doxyfile 1.5.6
     2.5 +
     2.6 +#---------------------------------------------------------------------------
     2.7 +# Project related configuration options
     2.8 +#---------------------------------------------------------------------------
     2.9 +DOXYFILE_ENCODING      = UTF-8
    2.10 +PROJECT_NAME           = POSIXoveFronty
    2.11 +PROJECT_NUMBER         = mq_fronty
    2.12 +OUTPUT_DIRECTORY       = /home/fiki/src/Priklady/c++/POSIXoveFronty/dokumentace/
    2.13 +CREATE_SUBDIRS         = NO
    2.14 +OUTPUT_LANGUAGE        = Czech
    2.15 +BRIEF_MEMBER_DESC      = YES
    2.16 +REPEAT_BRIEF           = YES
    2.17 +ABBREVIATE_BRIEF       = "The $name class" \
    2.18 +                         "The $name widget" \
    2.19 +                         "The $name file" \
    2.20 +                         is \
    2.21 +                         provides \
    2.22 +                         specifies \
    2.23 +                         contains \
    2.24 +                         represents \
    2.25 +                         a \
    2.26 +                         an \
    2.27 +                         the
    2.28 +ALWAYS_DETAILED_SEC    = NO
    2.29 +INLINE_INHERITED_MEMB  = NO
    2.30 +FULL_PATH_NAMES        = YES
    2.31 +STRIP_FROM_PATH        = /home/fiki/src/Priklady/c++/POSIXoveFronty/
    2.32 +STRIP_FROM_INC_PATH    = 
    2.33 +SHORT_NAMES            = NO
    2.34 +JAVADOC_AUTOBRIEF      = NO
    2.35 +QT_AUTOBRIEF           = NO
    2.36 +MULTILINE_CPP_IS_BRIEF = NO
    2.37 +DETAILS_AT_TOP         = NO
    2.38 +INHERIT_DOCS           = YES
    2.39 +SEPARATE_MEMBER_PAGES  = NO
    2.40 +TAB_SIZE               = 8
    2.41 +ALIASES                = 
    2.42 +OPTIMIZE_OUTPUT_FOR_C  = NO
    2.43 +OPTIMIZE_OUTPUT_JAVA   = NO
    2.44 +OPTIMIZE_FOR_FORTRAN   = NO
    2.45 +OPTIMIZE_OUTPUT_VHDL   = NO
    2.46 +BUILTIN_STL_SUPPORT    = NO
    2.47 +CPP_CLI_SUPPORT        = NO
    2.48 +SIP_SUPPORT            = NO
    2.49 +IDL_PROPERTY_SUPPORT   = YES
    2.50 +DISTRIBUTE_GROUP_DOC   = NO
    2.51 +SUBGROUPING            = YES
    2.52 +TYPEDEF_HIDES_STRUCT   = NO
    2.53 +#---------------------------------------------------------------------------
    2.54 +# Build related configuration options
    2.55 +#---------------------------------------------------------------------------
    2.56 +EXTRACT_ALL            = YES
    2.57 +EXTRACT_PRIVATE        = YES
    2.58 +EXTRACT_STATIC         = YES
    2.59 +EXTRACT_LOCAL_CLASSES  = YES
    2.60 +EXTRACT_LOCAL_METHODS  = NO
    2.61 +EXTRACT_ANON_NSPACES   = NO
    2.62 +HIDE_UNDOC_MEMBERS     = NO
    2.63 +HIDE_UNDOC_CLASSES     = NO
    2.64 +HIDE_FRIEND_COMPOUNDS  = NO
    2.65 +HIDE_IN_BODY_DOCS      = NO
    2.66 +INTERNAL_DOCS          = NO
    2.67 +CASE_SENSE_NAMES       = YES
    2.68 +HIDE_SCOPE_NAMES       = NO
    2.69 +SHOW_INCLUDE_FILES     = YES
    2.70 +INLINE_INFO            = YES
    2.71 +SORT_MEMBER_DOCS       = YES
    2.72 +SORT_BRIEF_DOCS        = NO
    2.73 +SORT_GROUP_NAMES       = NO
    2.74 +SORT_BY_SCOPE_NAME     = NO
    2.75 +GENERATE_TODOLIST      = YES
    2.76 +GENERATE_TESTLIST      = YES
    2.77 +GENERATE_BUGLIST       = YES
    2.78 +GENERATE_DEPRECATEDLIST= YES
    2.79 +ENABLED_SECTIONS       = 
    2.80 +MAX_INITIALIZER_LINES  = 30
    2.81 +SHOW_USED_FILES        = YES
    2.82 +SHOW_DIRECTORIES       = NO
    2.83 +SHOW_FILES             = YES
    2.84 +SHOW_NAMESPACES        = YES
    2.85 +FILE_VERSION_FILTER    = 
    2.86 +#---------------------------------------------------------------------------
    2.87 +# configuration options related to warning and progress messages
    2.88 +#---------------------------------------------------------------------------
    2.89 +QUIET                  = NO
    2.90 +WARNINGS               = YES
    2.91 +WARN_IF_UNDOCUMENTED   = YES
    2.92 +WARN_IF_DOC_ERROR      = YES
    2.93 +WARN_NO_PARAMDOC       = NO
    2.94 +WARN_FORMAT            = "$file:$line: $text"
    2.95 +WARN_LOGFILE           = 
    2.96 +#---------------------------------------------------------------------------
    2.97 +# configuration options related to the input files
    2.98 +#---------------------------------------------------------------------------
    2.99 +INPUT                  = /home/fiki/src/Priklady/c++/POSIXoveFronty/Fronta/
   2.100 +INPUT_ENCODING         = UTF-8
   2.101 +FILE_PATTERNS          = *.c \
   2.102 +                         *.cc \
   2.103 +                         *.cxx \
   2.104 +                         *.cpp \
   2.105 +                         *.c++ \
   2.106 +                         *.d \
   2.107 +                         *.java \
   2.108 +                         *.ii \
   2.109 +                         *.ixx \
   2.110 +                         *.ipp \
   2.111 +                         *.i++ \
   2.112 +                         *.inl \
   2.113 +                         *.h \
   2.114 +                         *.hh \
   2.115 +                         *.hxx \
   2.116 +                         *.hpp \
   2.117 +                         *.h++ \
   2.118 +                         *.idl \
   2.119 +                         *.odl \
   2.120 +                         *.cs \
   2.121 +                         *.php \
   2.122 +                         *.php3 \
   2.123 +                         *.inc \
   2.124 +                         *.m \
   2.125 +                         *.mm \
   2.126 +                         *.dox \
   2.127 +                         *.py \
   2.128 +                         *.f90 \
   2.129 +                         *.f \
   2.130 +                         *.vhd \
   2.131 +                         *.vhdl \
   2.132 +                         *.C \
   2.133 +                         *.CC \
   2.134 +                         *.C++ \
   2.135 +                         *.II \
   2.136 +                         *.I++ \
   2.137 +                         *.H \
   2.138 +                         *.HH \
   2.139 +                         *.H++ \
   2.140 +                         *.CS \
   2.141 +                         *.PHP \
   2.142 +                         *.PHP3 \
   2.143 +                         *.M \
   2.144 +                         *.MM \
   2.145 +                         *.PY \
   2.146 +                         *.F90 \
   2.147 +                         *.F \
   2.148 +                         *.VHD \
   2.149 +                         *.VHDL
   2.150 +RECURSIVE              = NO
   2.151 +EXCLUDE                = 
   2.152 +EXCLUDE_SYMLINKS       = NO
   2.153 +EXCLUDE_PATTERNS       = 
   2.154 +EXCLUDE_SYMBOLS        = 
   2.155 +EXAMPLE_PATH           = 
   2.156 +EXAMPLE_PATTERNS       = *
   2.157 +EXAMPLE_RECURSIVE      = NO
   2.158 +IMAGE_PATH             = 
   2.159 +INPUT_FILTER           = 
   2.160 +FILTER_PATTERNS        = 
   2.161 +FILTER_SOURCE_FILES    = NO
   2.162 +#---------------------------------------------------------------------------
   2.163 +# configuration options related to source browsing
   2.164 +#---------------------------------------------------------------------------
   2.165 +SOURCE_BROWSER         = YES
   2.166 +INLINE_SOURCES         = NO
   2.167 +STRIP_CODE_COMMENTS    = YES
   2.168 +REFERENCED_BY_RELATION = YES
   2.169 +REFERENCES_RELATION    = YES
   2.170 +REFERENCES_LINK_SOURCE = YES
   2.171 +USE_HTAGS              = NO
   2.172 +VERBATIM_HEADERS       = YES
   2.173 +#---------------------------------------------------------------------------
   2.174 +# configuration options related to the alphabetical class index
   2.175 +#---------------------------------------------------------------------------
   2.176 +ALPHABETICAL_INDEX     = NO
   2.177 +COLS_IN_ALPHA_INDEX    = 5
   2.178 +IGNORE_PREFIX          = 
   2.179 +#---------------------------------------------------------------------------
   2.180 +# configuration options related to the HTML output
   2.181 +#---------------------------------------------------------------------------
   2.182 +GENERATE_HTML          = YES
   2.183 +HTML_OUTPUT            = html
   2.184 +HTML_FILE_EXTENSION    = .html
   2.185 +HTML_HEADER            = 
   2.186 +HTML_FOOTER            = 
   2.187 +HTML_STYLESHEET        = 
   2.188 +HTML_ALIGN_MEMBERS     = YES
   2.189 +GENERATE_HTMLHELP      = NO
   2.190 +GENERATE_DOCSET        = NO
   2.191 +DOCSET_FEEDNAME        = "Doxygen generated docs"
   2.192 +DOCSET_BUNDLE_ID       = org.doxygen.Project
   2.193 +HTML_DYNAMIC_SECTIONS  = NO
   2.194 +CHM_FILE               = 
   2.195 +HHC_LOCATION           = 
   2.196 +GENERATE_CHI           = NO
   2.197 +CHM_INDEX_ENCODING     = 
   2.198 +BINARY_TOC             = NO
   2.199 +TOC_EXPAND             = NO
   2.200 +DISABLE_INDEX          = NO
   2.201 +ENUM_VALUES_PER_LINE   = 4
   2.202 +GENERATE_TREEVIEW      = NONE
   2.203 +TREEVIEW_WIDTH         = 250
   2.204 +FORMULA_FONTSIZE       = 10
   2.205 +#---------------------------------------------------------------------------
   2.206 +# configuration options related to the LaTeX output
   2.207 +#---------------------------------------------------------------------------
   2.208 +GENERATE_LATEX         = YES
   2.209 +LATEX_OUTPUT           = latex
   2.210 +LATEX_CMD_NAME         = latex
   2.211 +MAKEINDEX_CMD_NAME     = makeindex
   2.212 +COMPACT_LATEX          = NO
   2.213 +PAPER_TYPE             = a4wide
   2.214 +EXTRA_PACKAGES         = 
   2.215 +LATEX_HEADER           = 
   2.216 +PDF_HYPERLINKS         = YES
   2.217 +USE_PDFLATEX           = YES
   2.218 +LATEX_BATCHMODE        = NO
   2.219 +LATEX_HIDE_INDICES     = NO
   2.220 +#---------------------------------------------------------------------------
   2.221 +# configuration options related to the RTF output
   2.222 +#---------------------------------------------------------------------------
   2.223 +GENERATE_RTF           = NO
   2.224 +RTF_OUTPUT             = rtf
   2.225 +COMPACT_RTF            = NO
   2.226 +RTF_HYPERLINKS         = NO
   2.227 +RTF_STYLESHEET_FILE    = 
   2.228 +RTF_EXTENSIONS_FILE    = 
   2.229 +#---------------------------------------------------------------------------
   2.230 +# configuration options related to the man page output
   2.231 +#---------------------------------------------------------------------------
   2.232 +GENERATE_MAN           = YES
   2.233 +MAN_OUTPUT             = man
   2.234 +MAN_EXTENSION          = .3
   2.235 +MAN_LINKS              = NO
   2.236 +#---------------------------------------------------------------------------
   2.237 +# configuration options related to the XML output
   2.238 +#---------------------------------------------------------------------------
   2.239 +GENERATE_XML           = NO
   2.240 +XML_OUTPUT             = xml
   2.241 +XML_SCHEMA             = 
   2.242 +XML_DTD                = 
   2.243 +XML_PROGRAMLISTING     = YES
   2.244 +#---------------------------------------------------------------------------
   2.245 +# configuration options for the AutoGen Definitions output
   2.246 +#---------------------------------------------------------------------------
   2.247 +GENERATE_AUTOGEN_DEF   = NO
   2.248 +#---------------------------------------------------------------------------
   2.249 +# configuration options related to the Perl module output
   2.250 +#---------------------------------------------------------------------------
   2.251 +GENERATE_PERLMOD       = NO
   2.252 +PERLMOD_LATEX          = NO
   2.253 +PERLMOD_PRETTY         = YES
   2.254 +PERLMOD_MAKEVAR_PREFIX = 
   2.255 +#---------------------------------------------------------------------------
   2.256 +# Configuration options related to the preprocessor   
   2.257 +#---------------------------------------------------------------------------
   2.258 +ENABLE_PREPROCESSING   = YES
   2.259 +MACRO_EXPANSION        = NO
   2.260 +EXPAND_ONLY_PREDEF     = NO
   2.261 +SEARCH_INCLUDES        = YES
   2.262 +INCLUDE_PATH           = 
   2.263 +INCLUDE_FILE_PATTERNS  = 
   2.264 +PREDEFINED             = 
   2.265 +EXPAND_AS_DEFINED      = 
   2.266 +SKIP_FUNCTION_MACROS   = YES
   2.267 +#---------------------------------------------------------------------------
   2.268 +# Configuration::additions related to external references   
   2.269 +#---------------------------------------------------------------------------
   2.270 +TAGFILES               = 
   2.271 +GENERATE_TAGFILE       = 
   2.272 +ALLEXTERNALS           = NO
   2.273 +EXTERNAL_GROUPS        = YES
   2.274 +PERL_PATH              = /usr/bin/perl
   2.275 +#---------------------------------------------------------------------------
   2.276 +# Configuration options related to the dot tool   
   2.277 +#---------------------------------------------------------------------------
   2.278 +CLASS_DIAGRAMS         = NO
   2.279 +MSCGEN_PATH            = 
   2.280 +HIDE_UNDOC_RELATIONS   = YES
   2.281 +HAVE_DOT               = YES
   2.282 +DOT_FONTNAME           = FreeSans
   2.283 +DOT_FONTPATH           = 
   2.284 +CLASS_GRAPH            = YES
   2.285 +COLLABORATION_GRAPH    = YES
   2.286 +GROUP_GRAPHS           = YES
   2.287 +UML_LOOK               = NO
   2.288 +TEMPLATE_RELATIONS     = NO
   2.289 +INCLUDE_GRAPH          = YES
   2.290 +INCLUDED_BY_GRAPH      = YES
   2.291 +CALL_GRAPH             = YES
   2.292 +CALLER_GRAPH           = NO
   2.293 +GRAPHICAL_HIERARCHY    = YES
   2.294 +DIRECTORY_GRAPH        = YES
   2.295 +DOT_IMAGE_FORMAT       = png
   2.296 +DOT_PATH               = 
   2.297 +DOTFILE_DIRS           = 
   2.298 +DOT_GRAPH_MAX_NODES    = 50
   2.299 +MAX_DOT_GRAPH_DEPTH    = 1000
   2.300 +DOT_TRANSPARENT        = YES
   2.301 +DOT_MULTI_TARGETS      = NO
   2.302 +GENERATE_LEGEND        = YES
   2.303 +DOT_CLEANUP            = YES
   2.304 +#---------------------------------------------------------------------------
   2.305 +# Configuration::additions related to the search engine   
   2.306 +#---------------------------------------------------------------------------
   2.307 +SEARCHENGINE           = NO