From b546affe5ba8a057c84e2a79a18ce3cfe2832218 Mon Sep 17 00:00:00 2001 From: Tony Olagbaiye Date: Fri, 24 Apr 2020 03:23:11 +0100 Subject: [PATCH] tools: fix doxyfile --- tools/doxygen.conf => Doxyfile | 83 ++++++++++++++++++++++------------ README.md | 2 +- shell.nix | 2 +- 3 files changed, 56 insertions(+), 31 deletions(-) rename tools/doxygen.conf => Doxyfile (90%) diff --git a/tools/doxygen.conf b/Doxyfile similarity index 90% rename from tools/doxygen.conf rename to Doxyfile index b3faa4e44..6b3e345b8 100644 --- a/tools/doxygen.conf +++ b/Doxyfile @@ -1,17 +1,18 @@ -# Doxyfile 1.8.13 +# Doxyfile 1.8.17 #--------------------------------------------------------------------------- # Project related configuration options #--------------------------------------------------------------------------- DOXYFILE_ENCODING = UTF-8 PROJECT_NAME = "Construct" -PROJECT_NUMBER = 5 -PROJECT_BRIEF = "Internet Relay Chat daemon: Matrix Construct" -PROJECT_LOGO = modules/static/favicon.ico +PROJECT_NUMBER = 6 +PROJECT_BRIEF = "Fast and scalable chat homeserver: Matrix Construct" +PROJECT_LOGO = share/webapp/favicon.ico OUTPUT_DIRECTORY = doc/ CREATE_SUBDIRS = YES ALLOW_UNICODE_NAMES = NO OUTPUT_LANGUAGE = English +OUTPUT_TEXT_DIRECTION = None BRIEF_MEMBER_DESC = YES REPEAT_BRIEF = YES ABBREVIATE_BRIEF = "The $name class" \ @@ -58,11 +59,13 @@ INLINE_GROUPED_CLASSES = NO INLINE_SIMPLE_STRUCTS = NO TYPEDEF_HIDES_STRUCT = NO LOOKUP_CACHE_SIZE = 0 +# #--------------------------------------------------------------------------- # Build related configuration options #--------------------------------------------------------------------------- EXTRACT_ALL = YES EXTRACT_PRIVATE = YES +EXTRACT_PRIV_VIRTUAL = YES EXTRACT_PACKAGE = NO EXTRACT_STATIC = YES EXTRACT_LOCAL_CLASSES = YES @@ -76,8 +79,8 @@ INTERNAL_DOCS = YES CASE_SENSE_NAMES = YES HIDE_SCOPE_NAMES = NO HIDE_COMPOUND_REFERENCE= NO -SHOW_INCLUDE_FILES = NO -SHOW_GROUPED_MEMB_INC = NO +SHOW_INCLUDE_FILES = YES +SHOW_GROUPED_MEMB_INC = YES FORCE_LOCAL_INCLUDES = NO INLINE_INFO = YES SORT_MEMBER_DOCS = YES @@ -98,10 +101,12 @@ SHOW_NAMESPACES = YES FILE_VERSION_FILTER = LAYOUT_FILE = CITE_BIB_FILES = + #--------------------------------------------------------------------------- # Configuration options related to warning and progress messages #--------------------------------------------------------------------------- -QUIET = YES +#QUIET = YES +QUIET = NO WARNINGS = YES WARN_IF_UNDOCUMENTED = NO WARN_IF_DOC_ERROR = YES @@ -109,10 +114,12 @@ WARN_NO_PARAMDOC = NO WARN_AS_ERROR = NO WARN_FORMAT = "$file:$line: $text" WARN_LOGFILE = + #--------------------------------------------------------------------------- # Configuration options related to the input files #--------------------------------------------------------------------------- INPUT = include ircd construct modules +#INPUT = include construct modules INPUT_ENCODING = UTF-8 FILE_PATTERNS = *.c \ *.cc \ @@ -145,6 +152,7 @@ FILE_PATTERNS = *.c \ *.md \ *.mm \ *.dox \ + *.txt \ *.py \ *.pyw \ *.f90 \ @@ -158,7 +166,7 @@ FILE_PATTERNS = *.c \ *.vhdl \ *.ucf \ *.qsf -RECURSIVE = YES +#RECURSIVE = YES EXCLUDE = EXCLUDE_SYMLINKS = NO EXCLUDE_PATTERNS = @@ -172,6 +180,7 @@ FILTER_PATTERNS = FILTER_SOURCE_FILES = NO FILTER_SOURCE_PATTERNS = USE_MDFILE_AS_MAINPAGE = include/ircd/README.md + #--------------------------------------------------------------------------- # Configuration options related to source browsing #--------------------------------------------------------------------------- @@ -186,12 +195,14 @@ USE_HTAGS = NO VERBATIM_HEADERS = YES CLANG_ASSISTED_PARSING = YES CLANG_OPTIONS = -std=gnu++17 -I../include/ircd -I../include -include ../include/ircd/ircd.h + #--------------------------------------------------------------------------- # Configuration options related to the alphabetical class index #--------------------------------------------------------------------------- ALPHABETICAL_INDEX = YES COLS_IN_ALPHA_INDEX = 5 IGNORE_PREFIX = + #--------------------------------------------------------------------------- # Configuration options related to the HTML output #--------------------------------------------------------------------------- @@ -207,13 +218,14 @@ HTML_COLORSTYLE_HUE = 220 HTML_COLORSTYLE_SAT = 100 HTML_COLORSTYLE_GAMMA = 80 HTML_TIMESTAMP = NO +HTML_DYNAMIC_MENUS = YES HTML_DYNAMIC_SECTIONS = NO HTML_INDEX_NUM_ENTRIES = 100 GENERATE_DOCSET = NO DOCSET_FEEDNAME = "Doxygen generated docs" -DOCSET_BUNDLE_ID = org.doxygen.Project -DOCSET_PUBLISHER_ID = org.doxygen.Publisher -DOCSET_PUBLISHER_NAME = Publisher +DOCSET_BUNDLE_ID = org.doxygen.construct +DOCSET_PUBLISHER_ID = org.doxygen.construct +DOCSET_PUBLISHER_NAME = Matrix-Construct GENERATE_HTMLHELP = NO CHM_FILE = HHC_LOCATION = @@ -223,24 +235,25 @@ BINARY_TOC = NO TOC_EXPAND = NO GENERATE_QHP = NO QCH_FILE = -QHP_NAMESPACE = org.doxygen.Project +QHP_NAMESPACE = org.doxygen.construct QHP_VIRTUAL_FOLDER = doc QHP_CUST_FILTER_NAME = QHP_CUST_FILTER_ATTRS = QHP_SECT_FILTER_ATTRS = QHG_LOCATION = GENERATE_ECLIPSEHELP = NO -ECLIPSE_DOC_ID = org.doxygen.Project +ECLIPSE_DOC_ID = org.doxygen.construct DISABLE_INDEX = NO -GENERATE_TREEVIEW = NO +GENERATE_TREEVIEW = YES ENUM_VALUES_PER_LINE = 4 TREEVIEW_WIDTH = 250 EXT_LINKS_IN_WINDOW = NO FORMULA_FONTSIZE = 10 FORMULA_TRANSPARENT = YES -USE_MATHJAX = NO +FORMULA_MACROFILE = +USE_MATHJAX = YES MATHJAX_FORMAT = HTML-CSS -MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest +MATHJAX_RELPATH = https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/ MATHJAX_EXTENSIONS = MATHJAX_CODEFILE = SEARCHENGINE = YES @@ -250,13 +263,15 @@ SEARCHENGINE_URL = SEARCHDATA_FILE = searchdata.xml EXTERNAL_SEARCH_ID = EXTRA_SEARCH_MAPPINGS = + #--------------------------------------------------------------------------- # Configuration options related to the LaTeX output #--------------------------------------------------------------------------- -GENERATE_LATEX = NO +GENERATE_LATEX = YES LATEX_OUTPUT = latex -LATEX_CMD_NAME = latex +LATEX_CMD_NAME = MAKEINDEX_CMD_NAME = makeindex +LATEX_MAKEINDEX_CMD = makeindex COMPACT_LATEX = NO PAPER_TYPE = a4 EXTRA_PACKAGES = @@ -271,6 +286,8 @@ LATEX_HIDE_INDICES = NO LATEX_SOURCE_CODE = NO LATEX_BIB_STYLE = plain LATEX_TIMESTAMP = NO +LATEX_EMOJI_DIRECTORY = + #--------------------------------------------------------------------------- # Configuration options related to the RTF output #--------------------------------------------------------------------------- @@ -281,6 +298,7 @@ RTF_HYPERLINKS = NO RTF_STYLESHEET_FILE = RTF_EXTENSIONS_FILE = RTF_SOURCE_CODE = NO + #--------------------------------------------------------------------------- # Configuration options related to the man page output #--------------------------------------------------------------------------- @@ -289,22 +307,27 @@ MAN_OUTPUT = man MAN_EXTENSION = .3 MAN_SUBDIR = MAN_LINKS = NO + #--------------------------------------------------------------------------- # Configuration options related to the XML output #--------------------------------------------------------------------------- -GENERATE_XML = NO +GENERATE_XML = YES XML_OUTPUT = xml XML_PROGRAMLISTING = YES +XML_NS_MEMB_FILE_SCOPE = NO + #--------------------------------------------------------------------------- # Configuration options related to the DOCBOOK output #--------------------------------------------------------------------------- GENERATE_DOCBOOK = NO DOCBOOK_OUTPUT = docbook DOCBOOK_PROGRAMLISTING = NO + #--------------------------------------------------------------------------- # Configuration options for the AutoGen Definitions output #--------------------------------------------------------------------------- GENERATE_AUTOGEN_DEF = NO + #--------------------------------------------------------------------------- # Configuration options related to the Perl module output #--------------------------------------------------------------------------- @@ -312,32 +335,34 @@ GENERATE_PERLMOD = NO PERLMOD_LATEX = NO PERLMOD_PRETTY = YES PERLMOD_MAKEVAR_PREFIX = + #--------------------------------------------------------------------------- # Configuration options related to the preprocessor #--------------------------------------------------------------------------- ENABLE_PREPROCESSING = YES -MACRO_EXPANSION = NO +MACRO_EXPANSION = YES EXPAND_ONLY_PREDEF = NO SEARCH_INCLUDES = YES -INCLUDE_PATH = +INCLUDE_PATH = include INCLUDE_FILE_PATTERNS = PREDEFINED = EXPAND_AS_DEFINED = SKIP_FUNCTION_MACROS = YES + #--------------------------------------------------------------------------- # Configuration options related to external references #--------------------------------------------------------------------------- + TAGFILES = -GENERATE_TAGFILE = +GENERATE_TAGFILE = doc/TAGS ALLEXTERNALS = NO EXTERNAL_GROUPS = YES EXTERNAL_PAGES = YES -PERL_PATH = /usr/bin/perl + #--------------------------------------------------------------------------- # Configuration options related to the dot tool #--------------------------------------------------------------------------- CLASS_DIAGRAMS = YES -MSCGEN_PATH = DIA_PATH = HIDE_UNDOC_RELATIONS = YES HAVE_DOT = YES @@ -345,14 +370,14 @@ DOT_NUM_THREADS = 0 DOT_FONTNAME = Helvetica DOT_FONTSIZE = 10 DOT_FONTPATH = -CLASS_GRAPH = NO -COLLABORATION_GRAPH = NO +CLASS_GRAPH = YES +COLLABORATION_GRAPH = YES GROUP_GRAPHS = YES UML_LOOK = NO UML_LIMIT_NUM_FIELDS = 10 TEMPLATE_RELATIONS = YES -INCLUDE_GRAPH = NO -INCLUDED_BY_GRAPH = NO +INCLUDE_GRAPH = YES +INCLUDED_BY_GRAPH = YES CALL_GRAPH = NO CALLER_GRAPH = NO GRAPHICAL_HIERARCHY = YES @@ -371,4 +396,4 @@ MAX_DOT_GRAPH_DEPTH = 0 DOT_TRANSPARENT = NO DOT_MULTI_TARGETS = NO GENERATE_LEGEND = YES -DOT_CLEANUP = YES +DOT_CLEANUP = NO diff --git a/README.md b/README.md index a6cdd995b..770fb369e 100644 --- a/README.md +++ b/README.md @@ -67,7 +67,7 @@ problems. ##### DOCUMENTATION -Generate doxygen using `/usr/bin/doxygen tools/doxygen.conf` the target +Generate doxygen using `doxygen ./Doxyfile` the target directory is `doc/html`. Browse to `doc/html/index.html`. ##### ARCHITECTURE GUIDE diff --git a/shell.nix b/shell.nix index f6412131b..8766472b7 100644 --- a/shell.nix +++ b/shell.nix @@ -19,7 +19,7 @@ in pkgs.mkShell { graphicsmagick jemalloc ]; - nativeBuildInputs = with pkgs; [ git autoconf automake libtool gcc clang cmake pkg-config ]; + nativeBuildInputs = with pkgs; [ git autoconf automake libtool gcc clang cmake pkg-config doxygen graphviz ]; shellHook = '' WORKDIR=$(mktemp -d)