[Scummvm-git-logs] scummvm master -> 7192ec0bb5b3a519b97535667a2c5935112a9b7a

[criezy]

This automated email contains information about 1 new commit which have been
pushed to the 'scummvm' repo located at https://github.com/scummvm/scummvm .

Summary:
7192ec0bb5 DOXYGEN: Fix the build output and structure


Commit: 7192ec0bb5b3a519b97535667a2c5935112a9b7a
    https://github.com/scummvm/scummvm/commit/7192ec0bb5b3a519b97535667a2c5935112a9b7a
Author: Bartosz Gentkowski (bartosz.gentkowski at nordicsemi.no)
Date: 2020-12-02T22:55:41Z

Commit Message:
DOXYGEN: Fix the build output and structure

This commit introduces a couple tweaks to the
doxygen build configuration to assure the
overall structure looks correct.

Changed paths:
    base/plugins.h
    doc/doxygen/groups.dox
    doc/doxygen/mainpage.dox
    doc/doxygen/scummvm.doxyfile
    engines/sci/engine/kernel.h


diff --git a/base/plugins.h b/base/plugins.h
index 97e9ed1194..fb6ed182ec 100644
--- a/base/plugins.h
+++ b/base/plugins.h
@@ -33,27 +33,6 @@
 #undef INCLUDED_FROM_BASE_PLUGINS_H
 
 
-/**
- * @page pagePlugins An overview of the ScummVM plugin system
- * This is a brief overview of how plugins (dynamically loadable code modules)
- * work in ScummVM. We will explain how to write plugins, how they work internally,
- * and sketch how porters can add support for them in their ports.
- *
- * \section secPluginImpl Implementing a plugin
- * TODO
- *
- * \section secPluginUse Using plugins
- * TODO
- *
- * \section secPluginInternals How plugins work internally
- * TODO
- *
- * \section secPluginBackend How to add support for dynamic plugins to a port
- * TODO
- */
-
-
-
 // Plugin versioning
 
 /** Global Plugin API version */
diff --git a/doc/doxygen/groups.dox b/doc/doxygen/groups.dox
index de451ecf82..d340d968ac 100644
--- a/doc/doxygen/groups.dox
+++ b/doc/doxygen/groups.dox
@@ -27,6 +27,13 @@
 
 /**
 
+ at defgroup engines_engines Specific engines
+ at ingroup engines
+
+*/
+
+/**
+
 @defgroup graphics Graphics API
 @brief API related to on-screen graphics - surfaces, pixels, cursors, fonts, palettes, and renderers.
 
diff --git a/doc/doxygen/mainpage.dox b/doc/doxygen/mainpage.dox
index 081c43261e..7299b69280 100644
--- a/doc/doxygen/mainpage.dox
+++ b/doc/doxygen/mainpage.dox
@@ -2,6 +2,8 @@
 
 @mainpage ScummVM API reference
 
-These pages contain cross-referenced documentation for the ScummVM source code, generated with @linkDoxygen directly from the source. Currently, not much is properly documented, but at least you can get an overview of almost all the classes, methods, and variables, and how they interact.
+These pages contain cross-referenced documentation for the ScummVM source code, generated with @linkDoxygen directly from the source.
+
+Currently, not everything is properly documented but it is work in progress.
 
 */
diff --git a/doc/doxygen/scummvm.doxyfile b/doc/doxygen/scummvm.doxyfile
index ca93d0d079..648ce572a9 100644
--- a/doc/doxygen/scummvm.doxyfile
+++ b/doc/doxygen/scummvm.doxyfile
@@ -642,7 +642,7 @@ GENERATE_BUGLIST       = YES
 # the documentation.
 # The default value is: YES.
 
-GENERATE_DEPRECATEDLIST= YES
+GENERATE_DEPRECATEDLIST= NO
 
 # The ENABLED_SECTIONS tag can be used to enable conditional documentation
 # sections, marked by \if <section_label> ... \endif and \cond <section_label>
@@ -797,6 +797,7 @@ INPUT                  = groups.dox \
                          ../../backends \
 						 ../../base \
 						 ../../engines \
+						 ../../image \
 						 ../../graphics \
 						 ../../gui \
 						 ../../video \
@@ -840,7 +841,8 @@ RECURSIVE              = YES
 # Note that relative paths are relative to the directory from which doxygen is
 # run.
 
-EXCLUDE                = 
+EXCLUDE                = ../../engines/glk/  \
+                         ../../engines/tony/
 
 # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
 # directories that are symbolic links (a Unix file system feature) are excluded
@@ -856,7 +858,7 @@ EXCLUDE_SYMLINKS       = NO
 # Note that the wildcards are matched against the file with absolute path, so to
 # exclude all test directories for example use the pattern */test/*
 
-EXCLUDE_PATTERNS       = 
+EXCLUDE_PATTERNS       =
 
 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
 # (namespaces, classes, functions, etc.) that should be excluded from the
@@ -1219,7 +1221,7 @@ HTML_COLORSTYLE_GAMMA  = 240
 # The default value is: NO.
 # This tag requires that the tag GENERATE_HTML is set to YES.
 
-HTML_TIMESTAMP         = NO
+HTML_TIMESTAMP         = YES
 
 # If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML
 # documentation will contain a main index with vertical navigation menus that
diff --git a/engines/sci/engine/kernel.h b/engines/sci/engine/kernel.h
index 6605364e98..d64b719a85 100644
--- a/engines/sci/engine/kernel.h
+++ b/engines/sci/engine/kernel.h
@@ -34,13 +34,20 @@
 
 namespace Sci {
 
+/**
+ * @defgroup engine_sci SCI engine
+ * @ingroup engines_engines
+ * @{
+ */
+
 struct Node;	// from segment.h
 struct List;	// from segment.h
 struct SelectorCache;	// from selector.h
 struct SciWorkaroundEntry;	// from workarounds.h
 
 /**
- * @defgroup VocabularyResources	Vocabulary resources in SCI
+ * @defgroup vocabulary_resources_sci Vocabulary resources in SCI
+ * @ingroup engine_sci
  *
  * vocab.999 / 999.voc (unneeded) contains names of the kernel functions which
  * are implemented by the interpreter. In Sierra SCI, they are used exclusively
@@ -736,7 +743,7 @@ reg_t kFileIOGetCWD(EngineState *s, int argc, reg_t *argv);
 reg_t kFileIOIsValidDirectory(EngineState *s, int argc, reg_t *argv);
 #endif
 
-//@}
+/** @} */
 
 } // End of namespace Sci