Skip to content

Commit 7bf0ac5

Browse files
committed
Switched doxygen to sync with the wiki.
1 parent 63b28f2 commit 7bf0ac5

File tree

5 files changed

+16
-13
lines changed

5 files changed

+16
-13
lines changed

Doxyfile

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -743,7 +743,7 @@ SHOW_USED_FILES = YES
743743
# (if specified).
744744
# The default value is: YES.
745745

746-
SHOW_FILES = YES
746+
SHOW_FILES = NO
747747

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

867-
INPUT =
867+
INPUT = wiki/ \
868+
src/ \
869+
include/
868870

869871
# This tag can be used to specify the character encoding of the source files
870872
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
@@ -924,8 +926,8 @@ FILE_PATTERNS = *.c \
924926
*.md \
925927
*.mm \
926928
*.dox \
927-
# *.py \
928-
# *.pyw \
929+
# *.py \
930+
# *.pyw \
929931
*.f90 \
930932
*.f95 \
931933
*.f03 \
@@ -956,7 +958,8 @@ EXCLUDE = build/ \
956958
cmake-build-*/ \
957959
doxygen-awesome-css/ \
958960
venv/ \
959-
tests/
961+
wiki/_Footer.md \
962+
wiki/_Sidebar.md
960963

961964
# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
962965
# directories that are symbolic links (a Unix file system feature) are excluded
@@ -1065,7 +1068,7 @@ FILTER_SOURCE_PATTERNS =
10651068
# (index.html). This can be useful if you have a project on for instance GitHub
10661069
# and want to reuse the introduction page also for the doxygen output.
10671070

1068-
USE_MDFILE_AS_MAINPAGE = README.md
1071+
USE_MDFILE_AS_MAINPAGE = wiki/Home.md
10691072

10701073
#---------------------------------------------------------------------------
10711074
# Configuration options related to source browsing
@@ -2667,7 +2670,7 @@ DOT_CLEANUP = YES
26672670

26682671
EXTRACT_ALL = YES
26692672
EXTRACT_PRIVATE = YES
2670-
GENERATE_TREEVIEW = YES # optional. Also works without treeview
2673+
GENERATE_TREEVIEW = NO # optional. Also works without treeview
26712674
DISABLE_INDEX = NO
26722675
FULL_SIDEBAR = NO
26732676
HTML_EXTRA_STYLESHEET = doxygen-awesome-css/doxygen-awesome.css

include/colors.hpp

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ namespace steppable::__internals::utils
8282
std::ostream& reset(std::ostream& stream);
8383

8484
/**
85-
* @namespace colors
85+
* @namespace steppable::__internals::utils::colors
8686
* @brief A namespace containing functions to set the text color in an output stream.
8787
*/
8888
namespace colors
@@ -217,7 +217,7 @@ namespace steppable::__internals::utils
217217
} // namespace colors
218218

219219
/**
220-
* @namespace colorsBg
220+
* @namespace steppable::__internals::utils::colorsBg
221221
* @brief A namespace containing functions to set the background color in an output stream.
222222
*/
223223
namespace colorsBg
@@ -280,7 +280,7 @@ namespace steppable::__internals::utils
280280
} // namespace colorsBg
281281

282282
/**
283-
* @namespace formats
283+
* @namespace steppable::__internals::utils::formats
284284
* @brief A namespace containing functions to set the text format in an output stream.
285285
*/
286286
namespace formats

include/logging.hpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@
4242
#include <string>
4343

4444
/**
45-
* @namespace logging
45+
* @namespace steppable::__internals::logging
4646
* @brief The logging namespace contains classes and functions for logging.
4747
* The logging namespace contains the Logger class, which provides logging functionality, including logging messages
4848
* at different levels, such as error, warning, info, and debug. It writes the log messages to a specified log file.

include/platform.hpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@
3838
#include <mutex>
3939

4040
/**
41-
* @namespace internals
41+
* @namespace steppable::__internals::util
4242
* @brief Namespace for internal functions
4343
* @note This namespace should not be used by other programs outside of the Steppable core.
4444
*/

wiki

Submodule wiki updated from 0425e6a to 4e4ee7a

0 commit comments

Comments
 (0)