Mercurial > irccd

comparison doc/doxygen/Doxyfile.in @ 86:39fe49d294c8

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Docs: add lot of doxygen documentation, #453
author David Demelier <markand@malikania.fr>
date Tue, 05 Apr 2016 23:01:35 +0200
parents 1158cffe5a5e
children b0909b31eccb
comparison
equal deleted inserted replaced
85:6d48d409e9e9 86:39fe49d294c8
41 41
42 # Using the PROJECT_BRIEF tag one can provide an optional one line description 42 # Using the PROJECT_BRIEF tag one can provide an optional one line description
43 # for a project that appears at the top of each page and should give viewer a 43 # for a project that appears at the top of each page and should give viewer a
44 # quick idea about the purpose of the project. Keep the description short. 44 # quick idea about the purpose of the project. Keep the description short.
45 45
46 PROJECT_BRIEF = 46 PROJECT_BRIEF = "IRC Client Daemon"
47 47
48 # With the PROJECT_LOGO tag one can specify an logo or icon that is included in 48 # With the PROJECT_LOGO tag one can specify an logo or icon that is included in
49 # the documentation. The maximum height of the logo should not exceed 55 pixels 49 # the documentation. The maximum height of the logo should not exceed 55 pixels
50 # and the maximum width should not exceed 200 pixels. Doxygen will copy the logo 50 # and the maximum width should not exceed 200 pixels. Doxygen will copy the logo
51 # to the output directory. 51 # to the output directory.
141 # 141 #
142 # Note that you can specify absolute paths here, but also relative paths, which 142 # Note that you can specify absolute paths here, but also relative paths, which
143 # will be relative from the directory where doxygen is started. 143 # will be relative from the directory where doxygen is started.
144 # This tag requires that the tag FULL_PATH_NAMES is set to YES. 144 # This tag requires that the tag FULL_PATH_NAMES is set to YES.
145 145
146 STRIP_FROM_PATH = @DOXYGEN_INPUT@ 146 STRIP_FROM_PATH = @DOXYGEN_INPUT@/lib
147 147
148 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the 148 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
149 # path mentioned in the documentation of a class, which tells the reader which 149 # path mentioned in the documentation of a class, which tells the reader which
150 # header file to include in order to use a class. If left blank only the name of 150 # header file to include in order to use a class. If left blank only the name of
151 # the header file containing the class definition is used. Otherwise one should 151 # the header file containing the class definition is used. Otherwise one should
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@/irccd \ 745 INPUT = @DOXYGEN_INPUT@/lib
746 @DOXYGEN_INPUT@/irccdctl \
747 @DOXYGEN_INPUT@/common
748 746
749 # 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
750 # 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
751 # 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
752 # 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
762 # *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp, 760 # *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp,
763 # *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown, 761 # *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown,
764 # *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf, 762 # *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf,
765 # *.qsf, *.as and *.js. 763 # *.qsf, *.as and *.js.
766 764
767 FILE_PATTERNS = 765 FILE_PATTERNS = *.h
768 766
769 # 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
770 # be searched for input files as well. 768 # be searched for input files as well.
771 # The default value is: NO. 769 # The default value is: NO.
772 770
777 # 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.
778 # 776 #
779 # 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
780 # run. 778 # run.
781 779
782 EXCLUDE = 780 EXCLUDE = lib/irccd/server-private.h
783 781
784 # 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
785 # 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
786 # from the input. 784 # from the input.
787 # The default value is: NO. 785 # The default value is: NO.