From f6289baafeceacb4dd0c593c14e110b3c490079e Mon Sep 17 00:00:00 2001 From: Johnathan Chan Date: Tue, 16 Jul 2024 17:32:50 +1000 Subject: [PATCH 1/8] added theme added doxygen theme --- .github/workflows/doxygen.yml | 7 ++- .gitmodules | 3 + Doxyfile | 105 +++++++++++++++++++--------------- doxygen-awesome-css | 1 + 4 files changed, 69 insertions(+), 47 deletions(-) create mode 100644 .gitmodules create mode 160000 doxygen-awesome-css diff --git a/.github/workflows/doxygen.yml b/.github/workflows/doxygen.yml index 73fd903a..f8d244f3 100644 --- a/.github/workflows/doxygen.yml +++ b/.github/workflows/doxygen.yml @@ -8,7 +8,8 @@ on: - "include/**" - "Doxyfile" - "**/*.md" - + - ".github/workflows/doxygen.yml" +#test jobs: build-and-deploy: runs-on: ubuntu-latest @@ -16,6 +17,8 @@ jobs: steps: - name: Checkout code uses: actions/checkout@v4 + with: + submodules: recursive - name: Set up Doxygen run: | @@ -26,6 +29,6 @@ jobs: run: doxygen ./Doxyfile - name: Deploying to Gh-pages - uses: jinxto/doxygen-env-setup@v1 + uses: jinxto/doxygen-env-setup@v1.5 with: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} diff --git a/.gitmodules b/.gitmodules new file mode 100644 index 00000000..d8da1e47 --- /dev/null +++ b/.gitmodules @@ -0,0 +1,3 @@ +[submodule "doxygen-awesome-css"] + path = doxygen-awesome-css + url = https://github.com/jothepro/doxygen-awesome-css.git diff --git a/Doxyfile b/Doxyfile index 3683d109..a874ea02 100644 --- a/Doxyfile +++ b/Doxyfile @@ -1,26 +1,26 @@ DOXYFILE_ENCODING = UTF-8 -PROJECT_NAME = "mcpp" -PROJECT_NUMBER = -PROJECT_BRIEF = "mcpp is a library that lets you interact with Minecraft using C++" -PROJECT_LOGO = -OUTPUT_DIRECTORY = ./doc/ +PROJECT_NAME = "mcpp" +PROJECT_NUMBER = +PROJECT_BRIEF = "mcpp" +PROJECT_LOGO = ./resources/mcpplogosmall.png +OUTPUT_DIRECTORY = doc CREATE_SUBDIRS = NO +CREATE_SUBDIRS_LEVEL = 8 ALLOW_UNICODE_NAMES = NO OUTPUT_LANGUAGE = English -OUTPUT_TEXT_DIRECTION = None BRIEF_MEMBER_DESC = YES REPEAT_BRIEF = YES ABBREVIATE_BRIEF = "The $name class" \ "The $name widget" \ "The $name file" \ - is \ - provides \ - specifies \ - contains \ - represents \ - a \ - an \ - the + is \ + provides \ + specifies \ + contains \ + represents \ + a \ + an \ + the ALWAYS_DETAILED_SEC = NO INLINE_INHERITED_MEMB = NO FULL_PATH_NAMES = YES @@ -71,9 +71,10 @@ HIDE_UNDOC_CLASSES = NO HIDE_FRIEND_COMPOUNDS = NO HIDE_IN_BODY_DOCS = NO INTERNAL_DOCS = NO -CASE_SENSE_NAMES = YES +CASE_SENSE_NAMES = NO HIDE_SCOPE_NAMES = NO -HIDE_COMPOUND_REFERENCE= NO +HIDE_COMPOUND_REFERENCE = NO +SHOW_HEADERFILE = YES SHOW_INCLUDE_FILES = YES SHOW_GROUPED_MEMB_INC = NO FORCE_LOCAL_INCLUDES = NO @@ -87,7 +88,7 @@ STRICT_PROTO_MATCHING = NO GENERATE_TODOLIST = YES GENERATE_TESTLIST = YES GENERATE_BUGLIST = YES -GENERATE_DEPRECATEDLIST= YES +GENERATE_DEPRECATEDLIST = YES ENABLED_SECTIONS = MAX_INITIALIZER_LINES = 30 SHOW_USED_FILES = YES @@ -100,14 +101,17 @@ QUIET = NO WARNINGS = YES WARN_IF_UNDOCUMENTED = YES WARN_IF_DOC_ERROR = YES +WARN_IF_INCOMPLETE_DOC = YES WARN_NO_PARAMDOC = NO +WARN_IF_UNDOC_ENUM_VAL = NO WARN_AS_ERROR = NO WARN_FORMAT = "$file:$line: $text" +WARN_LINE_FORMAT = "at line $line of file $file" WARN_LOGFILE = -INPUT = include/mcpp \ - README.md - +INPUT = ./include/mcpp \ + ./README.md INPUT_ENCODING = UTF-8 +INPUT_FILE_ENCODING = FILE_PATTERNS = *.c \ *.cc \ *.cxx \ @@ -167,6 +171,7 @@ FILTER_PATTERNS = FILTER_SOURCE_FILES = NO FILTER_SOURCE_PATTERNS = USE_MDFILE_AS_MAINPAGE = README.md +FORTRAN_COMMENT_AFTER = 72 SOURCE_BROWSER = NO INLINE_SOURCES = NO STRIP_CODE_COMMENTS = YES @@ -185,23 +190,34 @@ IGNORE_PREFIX = GENERATE_HTML = YES HTML_OUTPUT = html HTML_FILE_EXTENSION = .html -HTML_HEADER = +HTML_HEADER = doxygen-awesome-css/doxygen-custom/header.html HTML_FOOTER = HTML_STYLESHEET = -HTML_EXTRA_STYLESHEET = -HTML_EXTRA_FILES = -HTML_COLORSTYLE_HUE = 220 -HTML_COLORSTYLE_SAT = 100 -HTML_COLORSTYLE_GAMMA = 80 +HTML_EXTRA_STYLESHEET = doxygen-awesome-css/doxygen-awesome.css \ + doxygen-awesome-css/doxygen-custom/custom.css \ + doxygen-awesome-css/doxygen-awesome-sidebar-only.css \ + doxygen-awesome-css/doxygen-awesome-sidebar-only-darkmode-toggle.css \ + doxygen-awesome-css/doxygen-custom/custom-alternative.css +HTML_EXTRA_FILES = doxygen-awesome-css/doxygen-awesome-darkmode-toggle.js \ + doxygen-awesome-css/doxygen-awesome-fragment-copy-button.js \ + doxygen-awesome-css/doxygen-awesome-paragraph-link.js \ + doxygen-awesome-css/doxygen-custom/toggle-alternative-theme.js \ + doxygen-awesome-css/doxygen-awesome-interactive-toc.js \ + doxygen-awesome-css/doxygen-awesome-tabs.js +HTML_COLORSTYLE = LIGHT +HTML_COLORSTYLE_HUE = 209 +HTML_COLORSTYLE_SAT = 255 +HTML_COLORSTYLE_GAMMA = 113 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_FEEDNAME = +DOCSET_FEEDURL = +DOCSET_BUNDLE_ID = +DOCSET_PUBLISHER_ID = +DOCSET_PUBLISHER_NAME = GENERATE_HTMLHELP = NO CHM_FILE = HHC_LOCATION = @@ -220,15 +236,17 @@ QHG_LOCATION = GENERATE_ECLIPSEHELP = NO ECLIPSE_DOC_ID = org.doxygen.Project DISABLE_INDEX = NO -GENERATE_TREEVIEW = NO +GENERATE_TREEVIEW = YES +FULL_SIDEBAR = NO ENUM_VALUES_PER_LINE = 4 -TREEVIEW_WIDTH = 250 +TREEVIEW_WIDTH = 335 EXT_LINKS_IN_WINDOW = NO +OBFUSCATE_EMAILS = YES HTML_FORMULA_FORMAT = png FORMULA_FONTSIZE = 10 -FORMULA_TRANSPARENT = YES FORMULA_MACROFILE = USE_MATHJAX = NO +MATHJAX_VERSION = MathJax_2 MATHJAX_FORMAT = HTML-CSS MATHJAX_RELPATH = https://cdn.jsdelivr.net/npm/mathjax@2 MATHJAX_EXTENSIONS = @@ -256,7 +274,6 @@ PDF_HYPERLINKS = YES USE_PDFLATEX = YES LATEX_BATCHMODE = NO LATEX_HIDE_INDICES = NO -LATEX_SOURCE_CODE = NO LATEX_BIB_STYLE = plain LATEX_TIMESTAMP = NO LATEX_EMOJI_DIRECTORY = @@ -266,7 +283,6 @@ COMPACT_RTF = NO RTF_HYPERLINKS = NO RTF_STYLESHEET_FILE = RTF_EXTENSIONS_FILE = -RTF_SOURCE_CODE = NO GENERATE_MAN = NO MAN_OUTPUT = man MAN_EXTENSION = .3 @@ -276,9 +292,8 @@ GENERATE_XML = NO XML_OUTPUT = xml XML_PROGRAMLISTING = YES XML_NS_MEMB_FILE_SCOPE = NO -GENERATE_DOCBOOK = YES +GENERATE_DOCBOOK = NO DOCBOOK_OUTPUT = docbook -DOCBOOK_PROGRAMLISTING = NO GENERATE_AUTOGEN_DEF = NO GENERATE_PERLMOD = NO PERLMOD_LATEX = NO @@ -290,7 +305,7 @@ EXPAND_ONLY_PREDEF = NO SEARCH_INCLUDES = YES INCLUDE_PATH = INCLUDE_FILE_PATTERNS = -PREDEFINED = DOXYGEN_LOGO +PREDEFINED = EXPAND_AS_DEFINED = SKIP_FUNCTION_MACROS = YES TAGFILES = @@ -298,16 +313,16 @@ GENERATE_TAGFILE = ALLEXTERNALS = NO EXTERNAL_GROUPS = YES EXTERNAL_PAGES = YES -CLASS_DIAGRAMS = YES DIA_PATH = HIDE_UNDOC_RELATIONS = YES HAVE_DOT = YES DOT_NUM_THREADS = 0 -DOT_FONTNAME = Helvetica -DOT_FONTSIZE = 10 +DOT_COMMON_ATTR = "fontname=Helvetica,fontsize=10" +DOT_EDGE_ATTR = "labelfontname=Helvetica,labelfontsize=10" +DOT_NODE_ATTR = "shape=box,height=0.2,width=0.4" DOT_FONTPATH = CLASS_GRAPH = YES -COLLABORATION_GRAPH = YES +COLLABORATION_GRAPH = NO GROUP_GRAPHS = YES UML_LOOK = NO UML_LIMIT_NUM_FIELDS = 10 @@ -320,7 +335,8 @@ CALL_GRAPH = NO CALLER_GRAPH = NO GRAPHICAL_HIERARCHY = YES DIRECTORY_GRAPH = YES -DOT_IMAGE_FORMAT = png +DIR_GRAPH_MAX_DEPTH = 1 +DOT_IMAGE_FORMAT = svg INTERACTIVE_SVG = NO DOT_PATH = DOTFILE_DIRS = @@ -331,7 +347,6 @@ PLANTUML_CFG_FILE = PLANTUML_INCLUDE_PATH = DOT_GRAPH_MAX_NODES = 50 MAX_DOT_GRAPH_DEPTH = 0 -DOT_TRANSPARENT = NO DOT_MULTI_TARGETS = NO GENERATE_LEGEND = YES -DOT_CLEANUP = YES +DOT_CLEANUP = YES \ No newline at end of file diff --git a/doxygen-awesome-css b/doxygen-awesome-css new file mode 160000 index 00000000..40e9b25b --- /dev/null +++ b/doxygen-awesome-css @@ -0,0 +1 @@ +Subproject commit 40e9b25b6174dd3b472d8868f63323a870dfeeb8 From a0ecff2ecad302a52ee14cd76c1c145f9729c92b Mon Sep 17 00:00:00 2001 From: Johnathan Chan <67891519+Jinxto@users.noreply.github.com> Date: Tue, 16 Jul 2024 18:27:20 +1000 Subject: [PATCH 2/8] fix styling issues --- .github/workflows/doxygen.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/.github/workflows/doxygen.yml b/.github/workflows/doxygen.yml index f8d244f3..29d401d3 100644 --- a/.github/workflows/doxygen.yml +++ b/.github/workflows/doxygen.yml @@ -9,7 +9,6 @@ on: - "Doxyfile" - "**/*.md" - ".github/workflows/doxygen.yml" -#test jobs: build-and-deploy: runs-on: ubuntu-latest From 7a680c14e7e85ff983abdadaaeaeb85869d90bac Mon Sep 17 00:00:00 2001 From: Johnathan Chan Date: Wed, 17 Jul 2024 19:40:00 +1000 Subject: [PATCH 3/8] private submodule test --- .github/workflows/doxygen.yml | 2 +- .gitmodules | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/doxygen.yml b/.github/workflows/doxygen.yml index f8d244f3..531a2e80 100644 --- a/.github/workflows/doxygen.yml +++ b/.github/workflows/doxygen.yml @@ -3,7 +3,7 @@ name: deploy-doxygen on: push: branches: - - main + - feature/branching paths: - "include/**" - "Doxyfile" diff --git a/.gitmodules b/.gitmodules index d8da1e47..55ae58b6 100644 --- a/.gitmodules +++ b/.gitmodules @@ -1,3 +1,3 @@ [submodule "doxygen-awesome-css"] path = doxygen-awesome-css - url = https://github.com/jothepro/doxygen-awesome-css.git + url = https://github.com/Jinxto/doxygen-theme.git \ No newline at end of file From d95294a0082770e3e9db5b4a8e89007067dd6bb1 Mon Sep 17 00:00:00 2001 From: Johnathan Chan Date: Wed, 17 Jul 2024 19:44:41 +1000 Subject: [PATCH 4/8] update submodule --- .gitmodules | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.gitmodules b/.gitmodules index 55ae58b6..06990887 100644 --- a/.gitmodules +++ b/.gitmodules @@ -1,3 +1,4 @@ [submodule "doxygen-awesome-css"] path = doxygen-awesome-css - url = https://github.com/Jinxto/doxygen-theme.git \ No newline at end of file + url = https://github.com/Jinxto/doxygen-theme.git + branch = main \ No newline at end of file From a1c95d2ee023d0febcedfc08f4c13792bd7ffd72 Mon Sep 17 00:00:00 2001 From: Johnathan Chan Date: Wed, 17 Jul 2024 19:47:15 +1000 Subject: [PATCH 5/8] fix embed --- .github/workflows/doxygen.yml | 2 +- .gitmodules | 6 +++--- Doxyfile | 2 +- doxygen-awesome-css | 2 +- 4 files changed, 6 insertions(+), 6 deletions(-) diff --git a/.github/workflows/doxygen.yml b/.github/workflows/doxygen.yml index 531a2e80..f8d244f3 100644 --- a/.github/workflows/doxygen.yml +++ b/.github/workflows/doxygen.yml @@ -3,7 +3,7 @@ name: deploy-doxygen on: push: branches: - - feature/branching + - main paths: - "include/**" - "Doxyfile" diff --git a/.gitmodules b/.gitmodules index 06990887..285567ed 100644 --- a/.gitmodules +++ b/.gitmodules @@ -1,4 +1,4 @@ [submodule "doxygen-awesome-css"] - path = doxygen-awesome-css - url = https://github.com/Jinxto/doxygen-theme.git - branch = main \ No newline at end of file + path = doxygen-awesome-css + url = https://github.com/Jinxto/doxygen-theme.git + branch = main diff --git a/Doxyfile b/Doxyfile index a874ea02..521040e2 100644 --- a/Doxyfile +++ b/Doxyfile @@ -349,4 +349,4 @@ DOT_GRAPH_MAX_NODES = 50 MAX_DOT_GRAPH_DEPTH = 0 DOT_MULTI_TARGETS = NO GENERATE_LEGEND = YES -DOT_CLEANUP = YES \ No newline at end of file +DOT_CLEANUP = YES diff --git a/doxygen-awesome-css b/doxygen-awesome-css index 40e9b25b..f52933b3 160000 --- a/doxygen-awesome-css +++ b/doxygen-awesome-css @@ -1 +1 @@ -Subproject commit 40e9b25b6174dd3b472d8868f63323a870dfeeb8 +Subproject commit f52933b3dbf6d4ab796c808d80f40f0057e027a0 From db77e3f9b3cbf1862c15987d35568bbc90437031 Mon Sep 17 00:00:00 2001 From: Johnathan Date: Sat, 3 Aug 2024 13:09:39 +1000 Subject: [PATCH 6/8] fix brief naming --- Doxyfile | 2 +- doxygen-awesome-css | 1 + 2 files changed, 2 insertions(+), 1 deletion(-) create mode 160000 doxygen-awesome-css diff --git a/Doxyfile b/Doxyfile index 3683d109..9e3e7868 100644 --- a/Doxyfile +++ b/Doxyfile @@ -1,7 +1,7 @@ DOXYFILE_ENCODING = UTF-8 PROJECT_NAME = "mcpp" PROJECT_NUMBER = -PROJECT_BRIEF = "mcpp is a library that lets you interact with Minecraft using C++" +PROJECT_BRIEF = "C++ Minecraft Library" PROJECT_LOGO = OUTPUT_DIRECTORY = ./doc/ CREATE_SUBDIRS = NO diff --git a/doxygen-awesome-css b/doxygen-awesome-css new file mode 160000 index 00000000..f52933b3 --- /dev/null +++ b/doxygen-awesome-css @@ -0,0 +1 @@ +Subproject commit f52933b3dbf6d4ab796c808d80f40f0057e027a0 From f8d5d8d76775dd00b97c786ce11ba25041aa44c4 Mon Sep 17 00:00:00 2001 From: Johnathan Chan <67891519+Jinxto@users.noreply.github.com> Date: Sat, 3 Aug 2024 17:51:06 +1000 Subject: [PATCH 7/8] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 49570c62..4f9b11a9 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -![mcpp logo](/resources/mcpplogosmall.png) +![mcpp logo](https://raw.githubusercontent.com/rozukke/mcpp/main/resources/mcpplogosmall.png) # mcpp From dae6dce0b72843da1a4a5c8bdf27a1804b1373ce Mon Sep 17 00:00:00 2001 From: s4016080-ps1nov Date: Mon, 12 Aug 2024 16:50:49 +1000 Subject: [PATCH 8/8] fix language --- include/mcpp/connection.h | 4 ++-- include/mcpp/mcpp.h | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/include/mcpp/connection.h b/include/mcpp/connection.h index d332b4f2..27bbd9d2 100644 --- a/include/mcpp/connection.h +++ b/include/mcpp/connection.h @@ -24,8 +24,8 @@ class SocketConnection { /** * Takes in parameters supporting std::stringstream conversion and a string - * prefix and transforms them into format "prefix(arg1,arg2,arg3)\n" (e.g. - * "chat.post(test)\n") and sends command to the server. + * prefix and transforms them into format "prefix(arg1,arg2,arg3)" e.g. + * "chat.post(test)" and sends command to the server. * * @tparam Types * @param prefix diff --git a/include/mcpp/mcpp.h b/include/mcpp/mcpp.h index a4abfa03..b2b34e04 100644 --- a/include/mcpp/mcpp.h +++ b/include/mcpp/mcpp.h @@ -129,7 +129,7 @@ class MinecraftConnection { * * ***IMPORTANT:*** * DO NOT USE FOR LARGE AREAS, IT WILL BE VERY SLOW - * USE getHeights() INSTEAD + * USE getHeights() instead * * Gets the y-value of the highest non-air block at the specified (x, z) * coordinate. @@ -143,7 +143,7 @@ class MinecraftConnection { * @brief Provides a scaled option of the getHeight call to allow for * considerable performance gains. * - * \par USE THIS instead of getHeight in a for loop. + * \par USE this instead of getHeight in a for loop. * * @param loc1 * @param loc2