Skip to content

Commit

Permalink
Switched doxygen to sync with GitHub wiki. (#22)
Browse files Browse the repository at this point in the history
  • Loading branch information
ZCG-coder committed May 9, 2024
2 parents 3e70044 + 7bf0ac5 commit 990a221
Show file tree
Hide file tree
Showing 6 changed files with 19 additions and 12 deletions.
3 changes: 3 additions & 0 deletions .gitmodules
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
[submodule "doxygen-awesome-css"]
path = doxygen-awesome-css
url = https://github.com/jothepro/doxygen-awesome-css.git
[submodule "wiki"]
path = wiki
url = https://github.com/ZCG-coder/Steppable.wiki.git
17 changes: 10 additions & 7 deletions Doxyfile
Original file line number Diff line number Diff line change
Expand Up @@ -743,7 +743,7 @@ SHOW_USED_FILES = YES
# (if specified).
# The default value is: YES.

SHOW_FILES = YES
SHOW_FILES = NO

# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
# page. This will remove the Namespaces entry from the Quick Index and from the
Expand Down Expand Up @@ -864,7 +864,9 @@ WARN_LOGFILE =
# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
# Note: If this tag is empty the current directory is searched.

INPUT =
INPUT = wiki/ \
src/ \
include/

# This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
Expand Down Expand Up @@ -924,8 +926,8 @@ FILE_PATTERNS = *.c \
*.md \
*.mm \
*.dox \
# *.py \
# *.pyw \
# *.py \
# *.pyw \
*.f90 \
*.f95 \
*.f03 \
Expand Down Expand Up @@ -956,7 +958,8 @@ EXCLUDE = build/ \
cmake-build-*/ \
doxygen-awesome-css/ \
venv/ \
tests/
wiki/_Footer.md \
wiki/_Sidebar.md

# 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
Expand Down Expand Up @@ -1065,7 +1068,7 @@ FILTER_SOURCE_PATTERNS =
# (index.html). This can be useful if you have a project on for instance GitHub
# and want to reuse the introduction page also for the doxygen output.

USE_MDFILE_AS_MAINPAGE = README.md
USE_MDFILE_AS_MAINPAGE = wiki/Home.md

#---------------------------------------------------------------------------
# Configuration options related to source browsing
Expand Down Expand Up @@ -2667,7 +2670,7 @@ DOT_CLEANUP = YES

EXTRACT_ALL = YES
EXTRACT_PRIVATE = YES
GENERATE_TREEVIEW = YES # optional. Also works without treeview
GENERATE_TREEVIEW = NO # optional. Also works without treeview
DISABLE_INDEX = NO
FULL_SIDEBAR = NO
HTML_EXTRA_STYLESHEET = doxygen-awesome-css/doxygen-awesome.css
Expand Down
6 changes: 3 additions & 3 deletions include/colors.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ namespace steppable::__internals::utils
std::ostream& reset(std::ostream& stream);

/**
* @namespace colors
* @namespace steppable::__internals::utils::colors
* @brief A namespace containing functions to set the text color in an output stream.
*/
namespace colors
Expand Down Expand Up @@ -217,7 +217,7 @@ namespace steppable::__internals::utils
} // namespace colors

/**
* @namespace colorsBg
* @namespace steppable::__internals::utils::colorsBg
* @brief A namespace containing functions to set the background color in an output stream.
*/
namespace colorsBg
Expand Down Expand Up @@ -280,7 +280,7 @@ namespace steppable::__internals::utils
} // namespace colorsBg

/**
* @namespace formats
* @namespace steppable::__internals::utils::formats
* @brief A namespace containing functions to set the text format in an output stream.
*/
namespace formats
Expand Down
2 changes: 1 addition & 1 deletion include/logging.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@
#include <string>

/**
* @namespace logging
* @namespace steppable::__internals::logging
* @brief The logging namespace contains classes and functions for logging.
* The logging namespace contains the Logger class, which provides logging functionality, including logging messages
* at different levels, such as error, warning, info, and debug. It writes the log messages to a specified log file.
Expand Down
2 changes: 1 addition & 1 deletion include/platform.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
#include <mutex>

/**
* @namespace internals
* @namespace steppable::__internals::util
* @brief Namespace for internal functions
* @note This namespace should not be used by other programs outside of the Steppable core.
*/
Expand Down
1 change: 1 addition & 0 deletions wiki
Submodule wiki added at 4e4ee7

0 comments on commit 990a221

Please sign in to comment.