docs: draft for new GUIDE documentation, updated code documentation

Author: San7o

CMakeLists.txt

@@ -156,18 +156,18 @@ list(APPEND BRENTA_DEPS_INCLUDES "external/tenno-tl/include")
 
 # Lua
 set(LUA_DIR "external/lua")
-set(LUA_FILES ${LUA_DIR}/lapi.c ${LUA_DIR}/lauxlib.c
-  ${LUA_DIR}/lbaselib.c ${LUA_DIR}/lcode.c ${LUA_DIR}/lcorolib.c
-  ${LUA_DIR}/lctype.c ${LUA_DIR}/ldblib.c ${LUA_DIR}/ldebug.c
-  ${LUA_DIR}/ldo.c ${LUA_DIR}/ldump.c ${LUA_DIR}/lfunc.c
-  ${LUA_DIR}/lgc.c ${LUA_DIR}/linit.c ${LUA_DIR}/liolib.c
-  ${LUA_DIR}/llex.c ${LUA_DIR}/lmathlib.c ${LUA_DIR}/lmem.c
-  ${LUA_DIR}/loadlib.c ${LUA_DIR}/lobject.c ${LUA_DIR}/lopcodes.c
-  ${LUA_DIR}/loslib.c ${LUA_DIR}/lparser.c ${LUA_DIR}/lstate.c
-  ${LUA_DIR}/lstring.c ${LUA_DIR}/lstrlib.c ${LUA_DIR}/ltable.c
-  ${LUA_DIR}/ltablib.c ${LUA_DIR}/ltests.c ${LUA_DIR}/ltm.c
-  ${LUA_DIR}/lundump.c ${LUA_DIR}/lutf8lib.c ${LUA_DIR}/lvm.c
-  ${LUA_DIR}/lzio.c)
+set(LUA_FILES
+  ${LUA_DIR}/lapi.c     ${LUA_DIR}/lauxlib.c   ${LUA_DIR}/lzio.c
+  ${LUA_DIR}/lbaselib.c ${LUA_DIR}/lcode.c     ${LUA_DIR}/lcorolib.c
+  ${LUA_DIR}/lctype.c   ${LUA_DIR}/ldblib.c    ${LUA_DIR}/ldebug.c
+  ${LUA_DIR}/ldo.c      ${LUA_DIR}/ldump.c     ${LUA_DIR}/lfunc.c
+  ${LUA_DIR}/lgc.c      ${LUA_DIR}/linit.c     ${LUA_DIR}/liolib.c
+  ${LUA_DIR}/llex.c     ${LUA_DIR}/lmathlib.c  ${LUA_DIR}/lmem.c
+  ${LUA_DIR}/loadlib.c  ${LUA_DIR}/lobject.c   ${LUA_DIR}/lopcodes.c
+  ${LUA_DIR}/loslib.c   ${LUA_DIR}/lparser.c   ${LUA_DIR}/lstate.c
+  ${LUA_DIR}/lstring.c  ${LUA_DIR}/lstrlib.c   ${LUA_DIR}/ltable.c
+  ${LUA_DIR}/ltablib.c  ${LUA_DIR}/ltests.c    ${LUA_DIR}/ltm.c
+  ${LUA_DIR}/lundump.c  ${LUA_DIR}/lutf8lib.c  ${LUA_DIR}/lvm.c)
 set(LUA_COMPILE_OPTIONS -Wextra -Wshadow -Wsign-compare -Wundef
   -Wwrite-strings -Wredundant-decls -Wdisabled-optimization
   -Waggregate-return -Wdouble-promotion -Wdeclaration-after-statement

Makefile

@@ -24,19 +24,23 @@ shaders-brenta: $(SHADERS)
 shaders-examples:
 	python3 utils/shaders_to_c.py --out-dir $(EXAMPLES_SHADERS_OUT_DIR) $(EXAMPLES_SHADERS)	
 
-DOCS_DIR := docs
-HTML_DIR := docs/html
-DOCS := ${wildcard ${DOCS_DIR}/*.md}
-HTML := ${patsubst ${DOCS_DIR}/%.md, ${HTML_DIR}/%.html, ${DOCS}}
-HTML_INTRO := utils/website/intro.html
-HTML_OUTRO := utils/website/outro.html
-TMP_FILE := /tmp/padoc-out.html
+#
+# Website
+#
+
+DOCS_DIR        := docs
+HTML_DIR        := docs/html
+DOCS            := ${wildcard ${DOCS_DIR}/*.md}
+HTML            := ${patsubst ${DOCS_DIR}/%.md, ${HTML_DIR}/%.html, ${DOCS}}
+HTML_INTRO      := utils/website/intro.html
+HTML_OUTRO      := utils/website/outro.html
+TMP_FILE        := /tmp/padoc-out.html
 HIGHLIGHT_STYLE := tango
-PANDOC_FLAGS := --highlight-style ${HIGHLIGHT_STYLE}
+PANDOC_FLAGS    := --highlight-style ${HIGHLIGHT_STYLE}
 
-html: doxygen ${HTML}
+html: doxygen ${HTML} ## Generate website and documentation
 
-doxygen:
+doxygen: ## Generate html documentation
 	doxygen ./utils/doxygen/doxygen.conf
 	mv ${HTML_DIR}/index.html ${HTML_DIR}/doxygen.html
 	cp -r utils/docs-images ${HTML_DIR}/images

TODO

@@ -1 +1,2 @@
+- move sound to the asset manager and make it non-static
 - rework website

docs/CONTRIBUTING.md

@@ -9,7 +9,7 @@ Here is an high-level overview of the main objects Brenta provides:
 
 ![brenta-picture](./brenta-picture.png)
 
-I wanted to write my own game engine primarely out of fascination and
+I wanted to write my own game engine primarily out of fascination and
 curiosity to understand how these big systems are designed and
 implemented. I found out that writing a game engine has a lot in
 common with writing an operating system. You are working with audio,