diff options
| author | Mistivia <i@mistivia.com> | 2025-10-23 23:44:03 +0800 |
|---|---|---|
| committer | Mistivia <i@mistivia.com> | 2025-10-23 23:44:07 +0800 |
| commit | c8aeef18cb46a617b6397b9822263895e97e9048 (patch) | |
| tree | ebe127e7c194039f315b74a5998b05a271c57b9d /ngircd/doc/src | |
add ircd
Diffstat (limited to 'ngircd/doc/src')
| -rw-r--r-- | ngircd/doc/src/Doxyfile | 93 | ||||
| -rw-r--r-- | ngircd/doc/src/Makefile.am | 25 | ||||
| -rw-r--r-- | ngircd/doc/src/footer.inc.html | 12 |
3 files changed, 130 insertions, 0 deletions
diff --git a/ngircd/doc/src/Doxyfile b/ngircd/doc/src/Doxyfile new file mode 100644 index 0000000..6d9ccb5 --- /dev/null +++ b/ngircd/doc/src/Doxyfile @@ -0,0 +1,93 @@ +# +# ngIRCd -- The Next Generation IRC Daemon +# Copyright (c)2001-2010 Alexander Barton (alex@barton.de) +# +# This program is free software; you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation; either version 2 of the License, or +# (at your option) any later version. +# Please read the file COPYING, README and AUTHORS for more information. +# +# This file describes the settings to be used by the documentation system +# doxygen (www.doxygen.org) for ngIRCd. +# + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- + +DOXYFILE_ENCODING = UTF-8 + +PROJECT_NAME = ngIRCd +PROJECT_BRIEF = "Lightweight Internet Relay Chat server" +PROJECT_LOGO = "../../contrib/ngIRCd-Logo.gif" + +OUTPUT_DIRECTORY = . +STRIP_FROM_PATH = ../.. + +JAVADOC_AUTOBRIEF = YES +OPTIMIZE_OUTPUT_FOR_C = YES +TYPEDEF_HIDES_STRUCT = YES + +TAB_SIZE = 8 + +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- + +EXTRACT_ALL = YES +EXTRACT_STATIC = YES + +SHOW_DIRECTORIES = YES + +#--------------------------------------------------------------------------- +# configuration options related to warning and progress messages +#--------------------------------------------------------------------------- + +QUIET = NO +WARNINGS = YES +WARN_IF_UNDOCUMENTED = YES +WARN_IF_DOC_ERROR = YES +WARN_NO_PARAMDOC = YES + +#--------------------------------------------------------------------------- +# configuration options related to the input files +#--------------------------------------------------------------------------- + +INPUT = ../../src +INPUT_ENCODING = UTF-8 +RECURSIVE = YES + +#--------------------------------------------------------------------------- +# configuration options related to source browsing +#--------------------------------------------------------------------------- + +SOURCE_BROWSER = YES +STRIP_CODE_COMMENTS = NO +REFERENCED_BY_RELATION = YES +REFERENCES_RELATION = YES + +#--------------------------------------------------------------------------- +# Output formats +#--------------------------------------------------------------------------- + +GENERATE_HTML = YES +HTML_FOOTER = footer.inc.html +HTML_DYNAMIC_SECTIONS = YES + +GENERATE_DOCSET = NO +GENERATE_HTMLHELP = NO +GENERATE_LATEX = NO +GENERATE_RTF = NO +GENERATE_MAN = NO +GENERATE_XML = NO +GENERATE_AUTOGEN_DEF = NO +GENERATE_PERLMOD = NO + +#--------------------------------------------------------------------------- +# Configuration options related to the preprocessor +#--------------------------------------------------------------------------- + +PREDEFINED = DEBUG ZLIB PAM ZEROCONF CONN_MODULE __client_c__ + +# -eof- diff --git a/ngircd/doc/src/Makefile.am b/ngircd/doc/src/Makefile.am new file mode 100644 index 0000000..0d27b7e --- /dev/null +++ b/ngircd/doc/src/Makefile.am @@ -0,0 +1,25 @@ +# +# ngIRCd -- The Next Generation IRC Daemon +# Copyright (c)2001-2011 Alexander Barton (alex@barton.de) and Contributors. +# +# This program is free software; you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation; either version 2 of the License, or +# (at your option) any later version. +# Please read the file COPYING, README and AUTHORS for more information. +# + +EXTRA_DIST = Doxyfile footer.inc.html + +maintainer-clean-local: + rm -f Makefile Makefile.in + +distclean-local: + rm -rf html + +srcdoc: + @doxygen --version >/dev/null 2>&1 \ + || ( echo; echo "Error: \"doxygen\" not found!"; echo; exit 1 ) + doxygen + +# -eof- diff --git a/ngircd/doc/src/footer.inc.html b/ngircd/doc/src/footer.inc.html new file mode 100644 index 0000000..6189afb --- /dev/null +++ b/ngircd/doc/src/footer.inc.html @@ -0,0 +1,12 @@ + +<hr class="footer"> +<p style="text-align: center"> + ngIRCd + <a href="https://ngircd.barton.de/">Homepage</a>. + GitHub: + <a href="https://github.com/ngircd/ngircd">Code Repository</a>, + <a href="https://github.com/ngircd/ngircd/issues">Bug-Tracker</a>. +</p> + +</body> +</html> |
