From ba16248f88372585b1c6dfb321d32a43bb99d596 Mon Sep 17 00:00:00 2001 From: Ivana Hrivnacova Date: Fri, 4 Dec 2020 15:16:12 +0100 Subject: [PATCH] Updates in Doxygen: - Disabled class diagrams generation in the default Doxygen configuration file and added doxyfile-with-graphs.in with class diagrams generation kept - Added doxygen keywords where missing to avoid low level documentation pages in the top level --- Detectors/DCS/README.md | 4 + Detectors/DCS/testWorkflow/README.md | 4 + Detectors/FIT/README.md | 1 + Detectors/FIT/raw/README.md | 4 + Detectors/README.md | 2 + Detectors/Upgrades/IT3/README.md | 4 + Detectors/Upgrades/PostLS4/IT4/README.md | 4 + Detectors/Upgrades/README.md | 8 +- Utilities/DataSampling/README.md | 4 + Utilities/README.md | 1 + doc/README.md | 1 + doc/doxyfile-with-graphs.in | 313 +++++++++++++++++++++++ doc/doxyfile.in | 4 +- prodtests/full-system-test/README.md | 4 + 14 files changed, 352 insertions(+), 6 deletions(-) create mode 100644 doc/doxyfile-with-graphs.in diff --git a/Detectors/DCS/README.md b/Detectors/DCS/README.md index 13cf1eebe53b2..16a2044e44a3f 100644 --- a/Detectors/DCS/README.md +++ b/Detectors/DCS/README.md @@ -18,3 +18,7 @@ auto dps = o2::dcs::generateRandomDataPoints(patterns,0.0,1200.0); ``` would generate 420 data points. + + diff --git a/Detectors/DCS/testWorkflow/README.md b/Detectors/DCS/testWorkflow/README.md index 2c4b879ab56eb..b00847e3f7761 100644 --- a/Detectors/DCS/testWorkflow/README.md +++ b/Detectors/DCS/testWorkflow/README.md @@ -1,3 +1,7 @@ + + Local example workflow with local CCDB (running on port 6464) : ```shell diff --git a/Detectors/FIT/README.md b/Detectors/FIT/README.md index 87c8647513541..49ca9ba65e85b 100644 --- a/Detectors/FIT/README.md +++ b/Detectors/FIT/README.md @@ -9,4 +9,5 @@ This is a top page for the FIT detector documentation. diff --git a/Detectors/FIT/raw/README.md b/Detectors/FIT/raw/README.md index dbc0c741e7c41..723ce05581370 100644 --- a/Detectors/FIT/raw/README.md +++ b/Detectors/FIT/raw/README.md @@ -1,3 +1,7 @@ + + # DataBlockBase DataBlockWrapper - wrapper for raw data structures\ There should be three static fields in raw data structs, which defines its "signature":\ diff --git a/Detectors/README.md b/Detectors/README.md index 89114fd394a66..b3d4bdbfc8e83 100644 --- a/Detectors/README.md +++ b/Detectors/README.md @@ -18,6 +18,7 @@ This module contains the following submodules: * \subpage refDetectorsCalibration * \subpage refDetectorsCPV * \subpage refDetectorsCTF +* \subpage refDetectorsDCS * \subpage refDetectorsEMCAL * \subpage refDetectorsDCS * \subpage refDetectorsFIT @@ -29,5 +30,6 @@ This module contains the following submodules: * \subpage refDetectorsTOF * \subpage refDetectorsTPC * \subpage refDetectorsTRD +* \subpage refDetectorsUpgrades * \subpage refDetectorsZDC /doxy --> diff --git a/Detectors/Upgrades/IT3/README.md b/Detectors/Upgrades/IT3/README.md index 3d57a976c41fa..9a4d82a533edb 100644 --- a/Detectors/Upgrades/IT3/README.md +++ b/Detectors/Upgrades/IT3/README.md @@ -1,3 +1,7 @@ + + # IT3 Upgraded version of the ITS that includes upgraded truly-cylindrical inner barrel. diff --git a/Detectors/Upgrades/PostLS4/IT4/README.md b/Detectors/Upgrades/PostLS4/IT4/README.md index 672f26326d8e1..02b76227f1a71 100644 --- a/Detectors/Upgrades/PostLS4/IT4/README.md +++ b/Detectors/Upgrades/PostLS4/IT4/README.md @@ -1,3 +1,7 @@ + + # IT4 At the moment the IT4 name is a placeholder for barrel detector. diff --git a/Detectors/Upgrades/README.md b/Detectors/Upgrades/README.md index c71db05187e1e..ecead5da1a376 100644 --- a/Detectors/Upgrades/README.md +++ b/Detectors/Upgrades/README.md @@ -1,5 +1,5 @@ # Upgrades @@ -14,6 +14,6 @@ ENABLE_UPGRADES=ON aliBuild build O2 --defaults o2 ``` \ No newline at end of file +* \subpage refDetectorsUpgradesIT3 +* \subpage refDetectorsUpgradesPostLS4IT4 +/doxy --> diff --git a/Utilities/DataSampling/README.md b/Utilities/DataSampling/README.md index b417f83beee2c..104890f06ceb8 100644 --- a/Utilities/DataSampling/README.md +++ b/Utilities/DataSampling/README.md @@ -1,3 +1,7 @@ + + ## Data Sampling Data Sampling provides a possibility to sample data in DPL workflows based on certain conditions ( 5% randomly, when a payload is greater than 4234 bytes, etc.). The job of passing the right data is done by a data processor called `Dispatcher`. A desired data stream is specified in form of Data Sampling Policies, configured by JSON structures (example below) or by using dedicated interface methods (for advanced use). diff --git a/Utilities/README.md b/Utilities/README.md index 026a778c559b1..48e1bfbb91473 100644 --- a/Utilities/README.md +++ b/Utilities/README.md @@ -11,6 +11,7 @@ This module contains the following submodules: * \subpage refUtilitiesDataCompression * \subpage refUtilitiesDataFlow +* \subpage refUtilitiesDataSampling * \subpage refUtilitiesMCStepLogger * \subpage refUtilitiesMergers * \subpage refUtilitiesO2Device diff --git a/doc/README.md b/doc/README.md index b699306179b00..68520ab356009 100644 --- a/doc/README.md +++ b/doc/README.md @@ -15,4 +15,5 @@ This module contains the documentation pages. * \subpage refdocDoxygenInstructions * \subpage refdocManPages * \subpage refdocUpgrades +* \subpage refprodtestsfull-system-test /doxy --> diff --git a/doc/doxyfile-with-graphs.in b/doc/doxyfile-with-graphs.in new file mode 100644 index 0000000000000..d60d01d5bcb59 --- /dev/null +++ b/doc/doxyfile-with-graphs.in @@ -0,0 +1,313 @@ +# Doxyfile 1.8.8 + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- +DOXYFILE_ENCODING = UTF-8 +PROJECT_NAME = @PROJECT_NAME@ +PROJECT_NUMBER = +PROJECT_BRIEF = +PROJECT_LOGO = "@CMAKE_SOURCE_DIR@/doc/images/o2_logo.png" +OUTPUT_DIRECTORY = "@DOC_OUTPUT_DIR@" +CREATE_SUBDIRS = YES +ALLOW_UNICODE_NAMES = NO +OUTPUT_LANGUAGE = English +BRIEF_MEMBER_DESC = YES +REPEAT_BRIEF = YES +ABBREVIATE_BRIEF = +ALWAYS_DETAILED_SEC = NO +INLINE_INHERITED_MEMB = NO +FULL_PATH_NAMES = YES +STRIP_FROM_PATH = +STRIP_FROM_INC_PATH = +SHORT_NAMES = NO +JAVADOC_AUTOBRIEF = NO +QT_AUTOBRIEF = NO +MULTILINE_CPP_IS_BRIEF = NO +INHERIT_DOCS = YES +SEPARATE_MEMBER_PAGES = NO +TAB_SIZE = 2 +ALIASES = +TCL_SUBST = +OPTIMIZE_OUTPUT_FOR_C = NO +OPTIMIZE_OUTPUT_JAVA = NO +OPTIMIZE_FOR_FORTRAN = NO +OPTIMIZE_OUTPUT_VHDL = NO +EXTENSION_MAPPING = +MARKDOWN_SUPPORT = YES +TOC_INCLUDE_HEADINGS = 0 +AUTOLINK_SUPPORT = YES +BUILTIN_STL_SUPPORT = NO +CPP_CLI_SUPPORT = NO +SIP_SUPPORT = NO +IDL_PROPERTY_SUPPORT = YES +DISTRIBUTE_GROUP_DOC = NO +SUBGROUPING = YES +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 = NO +EXTRACT_PACKAGE = NO +EXTRACT_STATIC = NO +EXTRACT_LOCAL_CLASSES = YES +EXTRACT_LOCAL_METHODS = NO +EXTRACT_ANON_NSPACES = NO +HIDE_UNDOC_MEMBERS = NO +HIDE_UNDOC_CLASSES = NO +HIDE_FRIEND_COMPOUNDS = NO +HIDE_IN_BODY_DOCS = NO +INTERNAL_DOCS = NO +CASE_SENSE_NAMES = YES +HIDE_SCOPE_NAMES = NO +SHOW_INCLUDE_FILES = YES +SHOW_GROUPED_MEMB_INC = NO +FORCE_LOCAL_INCLUDES = NO +INLINE_INFO = YES +SORT_MEMBER_DOCS = YES +SORT_BRIEF_DOCS = NO +SORT_MEMBERS_CTORS_1ST = NO +SORT_GROUP_NAMES = NO +SORT_BY_SCOPE_NAME = NO +STRICT_PROTO_MATCHING = NO +GENERATE_TODOLIST = YES +GENERATE_TESTLIST = YES +GENERATE_BUGLIST = YES +GENERATE_DEPRECATEDLIST= YES +ENABLED_SECTIONS = YES +MAX_INITIALIZER_LINES = 30 +SHOW_USED_FILES = YES +SHOW_FILES = YES +SHOW_NAMESPACES = YES +FILE_VERSION_FILTER = +LAYOUT_FILE = +CITE_BIB_FILES = +#--------------------------------------------------------------------------- +# Configuration options related to warning and progress messages +#--------------------------------------------------------------------------- +QUIET = YES +WARNINGS = YES +WARN_IF_UNDOCUMENTED = NO +WARN_IF_DOC_ERROR = YES +WARN_NO_PARAMDOC = NO +WARN_FORMAT = "$file:$line: $text" +WARN_LOGFILE = +#--------------------------------------------------------------------------- +# Configuration options related to the input files +#--------------------------------------------------------------------------- +INPUT = "@CMAKE_SOURCE_DIR@" +INPUT_ENCODING = UTF-8 +FILE_PATTERNS = *.cxx *.h *.inl *.md +RECURSIVE = YES +EXCLUDE = .git/ \ + build/ \ + build-dir/ \ + html-docs/ \ + doxygen cmake config gconfig geometry input parameters .svn vis +EXCLUDE_SYMLINKS = NO +EXCLUDE_PATTERNS = G__* ClassImp build_* +EXCLUDE_SYMBOLS = +EXAMPLE_PATH = +EXAMPLE_PATTERNS = +EXAMPLE_RECURSIVE = NO +IMAGE_PATH = +INPUT_FILTER = @CMAKE_SOURCE_DIR@/doc/scripts/filter_for_doxygen.sh +FILTER_PATTERNS = *.md +FILTER_SOURCE_FILES = NO +FILTER_SOURCE_PATTERNS = +USE_MDFILE_AS_MAINPAGE = @CMAKE_SOURCE_DIR@/README.md +#--------------------------------------------------------------------------- +# Configuration options related to source browsing +#--------------------------------------------------------------------------- +SOURCE_BROWSER = YES +INLINE_SOURCES = NO +STRIP_CODE_COMMENTS = YES +REFERENCED_BY_RELATION = NO +REFERENCES_RELATION = NO +REFERENCES_LINK_SOURCE = YES +SOURCE_TOOLTIPS = YES +USE_HTAGS = NO +VERBATIM_HEADERS = YES +#--------------------------------------------------------------------------- +# Configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- +ALPHABETICAL_INDEX = YES +COLS_IN_ALPHA_INDEX = 5 +IGNORE_PREFIX = .git +#--------------------------------------------------------------------------- +# Configuration options related to the HTML output +#--------------------------------------------------------------------------- +GENERATE_HTML = YES +HTML_OUTPUT = +HTML_FILE_EXTENSION = .html +HTML_HEADER = +HTML_FOOTER = +HTML_STYLESHEET = +HTML_EXTRA_STYLESHEET = +HTML_EXTRA_FILES = +HTML_COLORSTYLE_HUE = 220 +HTML_COLORSTYLE_SAT = 100 +HTML_COLORSTYLE_GAMMA = 80 +HTML_TIMESTAMP = 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 +GENERATE_HTMLHELP = NO +CHM_FILE = +HHC_LOCATION = +GENERATE_CHI = NO +CHM_INDEX_ENCODING = +BINARY_TOC = NO +TOC_EXPAND = NO +GENERATE_QHP = NO +QCH_FILE = +QHP_NAMESPACE = org.doxygen.Project +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 +DISABLE_INDEX = 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 +MATHJAX_FORMAT = HTML-CSS +MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest +MATHJAX_EXTENSIONS = +MATHJAX_CODEFILE = +SEARCHENGINE = YES +SERVER_BASED_SEARCH = NO +EXTERNAL_SEARCH = NO +SEARCHENGINE_URL = +SEARCHDATA_FILE = searchdata.xml +EXTERNAL_SEARCH_ID = +EXTRA_SEARCH_MAPPINGS = +#--------------------------------------------------------------------------- +# Configuration options related to the LaTeX output +#--------------------------------------------------------------------------- +GENERATE_LATEX = NO +LATEX_OUTPUT = latex +LATEX_CMD_NAME = latex +MAKEINDEX_CMD_NAME = makeindex +COMPACT_LATEX = NO +PAPER_TYPE = a4 +EXTRA_PACKAGES = +LATEX_HEADER = +LATEX_FOOTER = +LATEX_EXTRA_FILES = +PDF_HYPERLINKS = YES +USE_PDFLATEX = YES +LATEX_BATCHMODE = NO +LATEX_HIDE_INDICES = NO +LATEX_SOURCE_CODE = NO +LATEX_BIB_STYLE = plain +#--------------------------------------------------------------------------- +# Configuration options related to the RTF output +#--------------------------------------------------------------------------- +GENERATE_RTF = NO +RTF_OUTPUT = rtf +COMPACT_RTF = NO +RTF_HYPERLINKS = NO +RTF_STYLESHEET_FILE = +RTF_EXTENSIONS_FILE = +#--------------------------------------------------------------------------- +# Configuration options related to the man page output +#--------------------------------------------------------------------------- +GENERATE_MAN = NO +MAN_OUTPUT = man +MAN_EXTENSION = .3 +MAN_SUBDIR = +MAN_LINKS = NO +#--------------------------------------------------------------------------- +# Configuration options related to the XML output +#--------------------------------------------------------------------------- +GENERATE_XML = NO +XML_OUTPUT = xml +XML_PROGRAMLISTING = YES +#--------------------------------------------------------------------------- +# 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 +#--------------------------------------------------------------------------- +GENERATE_PERLMOD = NO +PERLMOD_LATEX = NO +PERLMOD_PRETTY = YES +PERLMOD_MAKEVAR_PREFIX = +#--------------------------------------------------------------------------- +# Configuration options related to the preprocessor +#--------------------------------------------------------------------------- +ENABLE_PREPROCESSING = YES +MACRO_EXPANSION = NO +EXPAND_ONLY_PREDEF = NO +SEARCH_INCLUDES = YES +INCLUDE_PATH = +INCLUDE_FILE_PATTERNS = +PREDEFINED = +EXPAND_AS_DEFINED = +SKIP_FUNCTION_MACROS = YES +#--------------------------------------------------------------------------- +# Configuration options related to external references +#--------------------------------------------------------------------------- +TAGFILES = +GENERATE_TAGFILE = +ALLEXTERNALS = NO +EXTERNAL_GROUPS = YES +EXTERNAL_PAGES = YES +#--------------------------------------------------------------------------- +# Configuration options related to the dot tool +#--------------------------------------------------------------------------- +CLASS_DIAGRAMS = YES +DIA_PATH = +HIDE_UNDOC_RELATIONS = NO +HAVE_DOT = YES +DOT_NUM_THREADS = 1 +DOT_FONTNAME = Helvetica +DOT_FONTSIZE = 10 +DOT_FONTPATH = +CLASS_GRAPH = YES +COLLABORATION_GRAPH = YES +GROUP_GRAPHS = YES +UML_LOOK = YES +UML_LIMIT_NUM_FIELDS = 50 +TEMPLATE_RELATIONS = YES +INCLUDE_GRAPH = YES +INCLUDED_BY_GRAPH = YES +CALL_GRAPH = NO +CALLER_GRAPH = NO +GRAPHICAL_HIERARCHY = YES +DIRECTORY_GRAPH = YES +DOT_IMAGE_FORMAT = svg +INTERACTIVE_SVG = YES +DOT_PATH = "@DOT_PATH@" +DOTFILE_DIRS = +MSCFILE_DIRS = +DIAFILE_DIRS = +PLANTUML_JAR_PATH = +DOT_GRAPH_MAX_NODES = 100 +MAX_DOT_GRAPH_DEPTH = 0 +DOT_TRANSPARENT = YES +DOT_MULTI_TARGETS = YES +GENERATE_LEGEND = YES +DOT_CLEANUP = YES diff --git a/doc/doxyfile.in b/doc/doxyfile.in index d60d01d5bcb59..08b7d37770b20 100644 --- a/doc/doxyfile.in +++ b/doc/doxyfile.in @@ -278,10 +278,10 @@ EXTERNAL_PAGES = YES #--------------------------------------------------------------------------- # Configuration options related to the dot tool #--------------------------------------------------------------------------- -CLASS_DIAGRAMS = YES +CLASS_DIAGRAMS = NO DIA_PATH = HIDE_UNDOC_RELATIONS = NO -HAVE_DOT = YES +HAVE_DOT = NO DOT_NUM_THREADS = 1 DOT_FONTNAME = Helvetica DOT_FONTSIZE = 10 diff --git a/prodtests/full-system-test/README.md b/prodtests/full-system-test/README.md index 9f918b9b1796d..02da768bcc020 100644 --- a/prodtests/full-system-test/README.md +++ b/prodtests/full-system-test/README.md @@ -1,3 +1,7 @@ + + ## Full system test configuration and scripts The full system test workflow scripts consist of 3 shell scripts: