Mercurial > irccd

comparison doc/doxygen/Doxyfile.in @ 180:b0909b31eccb

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Docs: improve a lot doxygen, #453
author David Demelier <markand@malikania.fr>
date Tue, 31 May 2016 22:13:35 +0200
parents 39fe49d294c8
children 6635b9187d71
comparison
equal deleted inserted replaced
179:ef527409e638 180:b0909b31eccb
5 # 5 #
6 # The following variables are set by CMake: 6 # The following variables are set by CMake:
7 # 7 #
8 # VERSION - The project version 8 # VERSION - The project version
9 # DOXYGEN_INPUT - The source directory 9 # DOXYGEN_INPUT - The source directory
10 # DOXYGEN_OUTPUT - The output directory (doc/generated/doxygen) 10 # DOXYGEN_OUTPUT - The output directory
11 # DOXYGEN_HAVE_DOT - True if have dot 11 # DOXYGEN_HAVE_DOT - True if have dot
12 # DOXYGEN_DOT_PATH - The path to dot 12 # DOXYGEN_DOT_PATH - The path to dot
13 # 13 #
14 14
15 #--------------------------------------------------------------------------- 15 #---------------------------------------------------------------------------
55 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path 55 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
56 # into which the generated documentation will be written. If a relative path is 56 # into which the generated documentation will be written. If a relative path is
57 # entered, it will be relative to the location where doxygen was started. If 57 # entered, it will be relative to the location where doxygen was started. If
58 # left blank the current directory will be used. 58 # left blank the current directory will be used.
59 59
60 OUTPUT_DIRECTORY = @CMAKE_BINARY_DIR@/docs/doxygen 60 OUTPUT_DIRECTORY = @DOXYGEN_OUTPUT@
61 61
62 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub- 62 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub-
63 # directories (in 2 levels) under the output directory of each output format and 63 # directories (in 2 levels) under the output directory of each output format and
64 # will distribute the generated files over these directories. Enabling this 64 # will distribute the generated files over these directories. Enabling this
65 # option can be useful when feeding doxygen a huge amount of source files, where 65 # option can be useful when feeding doxygen a huge amount of source files, where
129 # If the FULL_PATH_NAMES tag is set to YES doxygen will prepend the full path 129 # If the FULL_PATH_NAMES tag is set to YES doxygen will prepend the full path
130 # before files name in the file list and in the header files. If set to NO the 130 # before files name in the file list and in the header files. If set to NO the
131 # shortest path that makes the file name unique will be used 131 # shortest path that makes the file name unique will be used
132 # The default value is: YES. 132 # The default value is: YES.
133 133
134 FULL_PATH_NAMES = YES 134 FULL_PATH_NAMES = NO
135 135
136 # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. 136 # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
137 # Stripping is only done if one of the specified strings matches the left-hand 137 # Stripping is only done if one of the specified strings matches the left-hand
138 # part of the path. The tag can be used to show relative paths in the file list. 138 # part of the path. The tag can be used to show relative paths in the file list.
139 # If left blank the directory from which doxygen is run is used as the path to 139 # If left blank the directory from which doxygen is run is used as the path to
740 # documented source files. You may enter file names like myfile.cpp or 740 # documented source files. You may enter file names like myfile.cpp or
741 # directories like /usr/src/myproject. Separate the files or directories with 741 # directories like /usr/src/myproject. Separate the files or directories with
742 # spaces. 742 # spaces.
743 # Note: If this tag is empty the current directory is searched. 743 # Note: If this tag is empty the current directory is searched.
744 744
745 INPUT = @DOXYGEN_INPUT@/lib 745 INPUT = @DOXYGEN_INPUT@
746 746
747 # This tag can be used to specify the character encoding of the source files 747 # This tag can be used to specify the character encoding of the source files
748 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses 748 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
749 # libiconv (or the iconv built into libc) for the transcoding. See the libiconv 749 # libiconv (or the iconv built into libc) for the transcoding. See the libiconv
750 # documentation (see: http://www.gnu.org/software/libiconv) for the list of 750 # documentation (see: http://www.gnu.org/software/libiconv) for the list of
760 # *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp, 760 # *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp,
761 # *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown, 761 # *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown,
762 # *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf, 762 # *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf,
763 # *.qsf, *.as and *.js. 763 # *.qsf, *.as and *.js.
764 764
765 FILE_PATTERNS = *.h 765 FILE_PATTERNS = *.hpp
766 766
767 # The RECURSIVE tag can be used to specify whether or not subdirectories should 767 # The RECURSIVE tag can be used to specify whether or not subdirectories should
768 # be searched for input files as well. 768 # be searched for input files as well.
769 # The default value is: NO. 769 # The default value is: NO.
770 770
775 # subdirectory from a directory tree whose root is specified with the INPUT tag. 775 # subdirectory from a directory tree whose root is specified with the INPUT tag.
776 # 776 #
777 # Note that relative paths are relative to the directory from which doxygen is 777 # Note that relative paths are relative to the directory from which doxygen is
778 # run. 778 # run.
779 779
780 EXCLUDE = lib/irccd/server-private.h 780 EXCLUDE = lib/irccd/server-private.hpp
781 781
782 # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or 782 # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
783 # directories that are symbolic links (a Unix file system feature) are excluded 783 # directories that are symbolic links (a Unix file system feature) are excluded
784 # from the input. 784 # from the input.
785 # The default value is: NO. 785 # The default value is: NO.