Huge documentation update WIP

.gitignore

@@ -9,9 +9,7 @@
 doc/_build
 doc/_static
 doc/_templates
-doc/html
-doc/latex
-doc/xml
+doc/doxygen
 
 # Created by https://www.gitignore.io/api/platformio
 # Edit at https://www.gitignore.io/?templates=platformio

doc/AvailableAnimations.rst

@@ -0,0 +1,23 @@
+
+.. _available-animations:
+
+Available Animations
+=====================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Animations:
+
+This is a list of the available animations for the different clock configurations
+
+Default
+=====================================
+.. doxygenfile:: default/Animations.h
+
+Clock Only
+=====================================
+.. doxygenfile:: clock-only/Animations.h
+
+DIY-Machines
+=====================================
+.. doxygenfile:: diy-machines/Animations.h

doc/GeneralConfiguration.rst

@@ -0,0 +1,18 @@
+
+.. _general-configuration:
+
+General Configuration
+=====================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: General Configuration:
+
+
+Display configuration
+=====================================
+.. doxygengroup:: DisplayConfiguration
+
+Configuration parameters
+=====================================
+.. doxygengroup:: MainConfiguration

doc/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

doc/conf.py

@@ -0,0 +1,58 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+# import os
+# import sys
+import subprocess
+# sys.path.insert(0, os.path.abspath('..'))
+# sys.path.insert(0, os.path.abspath('../lib/LED_clock/Config/Setup'))
+
+
+subprocess.call('doxygen', shell=True)
+
+
+
+# -- Project information -----------------------------------------------------
+
+project = 'LED-Clock'
+copyright = '2021, Florian Laschober'
+author = 'Florian Laschober'
+
+# The full version, including alpha/beta/rc tags
+release = '2.0.0'
+
+primary_domain = 'c'
+
+
+# -- General configuration ---------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = ["breathe"]
+
+breathe_projects = { "LED-Clock": "./doxygen/xml" }
+
+breathe_default_project = "LED-Clock"
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', 'doxygen']
+
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = 'sphinx_rtd_theme'

doc/index.rst

@@ -0,0 +1,19 @@
+Welcome to LED-Clock's documentation!
+=====================================
+
+.. toctree::
+   :maxdepth: 2
+
+   GeneralConfiguration
+   AvailableAnimations
+
+
+WIP
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

doc/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=.
+set BUILDDIR=_build
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.http://sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

doc/requirements.txt

@@ -0,0 +1 @@
+breathe

lib/LED_clock/Config/Animations/clock-only/Animations.cpp

@@ -1,8 +1,25 @@
+/**
+ * \file Animations.cpp
+ * \author Florian Laschober
+ * \brief Implementations of all preconfigured animations avaliable.
+ * 		  Animations designed for a fully featured 24h display with intermediate segments between the digits
+ */
+
 #include "Animations.h"
 
 Animator::ComplexAmination* InitLoadingAnimation(uint16_t totalAnimationLength);
+/**
+ * \brief Initialize the animation in global context to make it usable.
+ *
+ */
 Animator::ComplexAmination* LoadingAnimation = InitLoadingAnimation(LOADING_ANIMATION_DURATION);
 
+/**
+ * \brief Initialize the loading animation
+ *
+ * \param totalAnimationLength Duration of the whole animation in milliseconds
+ * \return Animator::ComplexAmination* pointer to the newly created animation
+ */
 Animator::ComplexAmination* InitLoadingAnimation(uint16_t totalAnimationLength)
 {
 	#undef LENGTH
@@ -50,4 +67,4 @@ Animator::ComplexAmination* InitLoadingAnimation(uint16_t totalAnimationLength)
 	animation->LengthPerAnimation 	= totalAnimationLength / allSteps->size();
 	animation->animations 			= allSteps;
 	return animation;
-}
+}

lib/LED_clock/Config/Animations/clock-only/Animations.h

@@ -1,8 +1,21 @@
+/**
+ * \file Animations.h
+ * \author Florian Laschober
+ * \brief Animations designed for a fully featured 24h display with intermediate segments between the digits
+ */
+
 #ifndef __ANIMATIONS_H_
 #define __ANIMATIONS_H_
 
 #include "DisplayManager.h"
 
+/**
+ * \brief Animation to be used during some indefinite loading operation.
+ *        Loops along the outside of all segments in a "circle".
+ *        Suppposed to be used as a endlessly looping animation and to be
+ *        stopped by calling the stopLooping method as soon as loading is finished.
+ *
+ */
 extern Animator::ComplexAmination* LoadingAnimation;
 
-#endif
+#endif

lib/LED_clock/Config/Animations/default/Animations.cpp

@@ -1,8 +1,25 @@
+/**
+ * \file Animations.cpp
+ * \author Florian Laschober
+ * \brief Implementations of all preconfigured animations avaliable.
+ * 		  The default animations designed for a 12h display with intermediate segments between the digits
+ */
+
 #include "Animations.h"
 
 Animator::ComplexAmination* InitLoadingAnimation(uint16_t totalAnimationLength);
+/**
+ * \brief Initialize the animation in global context to make it usable.
+ *
+ */
 Animator::ComplexAmination* LoadingAnimation = InitLoadingAnimation(LOADING_ANIMATION_DURATION);
 
+/**
+ * \brief Initialize the loading animation
+ *
+ * \param totalAnimationLength Duration of the whole animation in milliseconds
+ * \return Animator::ComplexAmination* pointer to the newly created animation
+ */
 Animator::ComplexAmination* InitLoadingAnimation(uint16_t totalAnimationLength)
 {
 	#undef LENGTH
@@ -100,4 +117,4 @@ Animator::ComplexAmination* InitLoadingAnimation(uint16_t totalAnimationLength)
 	animation->LengthPerAnimation 	= totalAnimationLength / allSteps->size();
 	animation->animations 			= allSteps;
 	return animation;
-}
+}

lib/LED_clock/Config/Animations/default/Animations.h

@@ -1,8 +1,21 @@
+/**
+ * \file Animations.h
+ * \author Florian Laschober
+ * \brief The default animations designed for a 12h display with intermediate segments between the digits
+ */
+
 #ifndef __ANIMATIONS_H_
 #define __ANIMATIONS_H_
 
 #include "DisplayManager.h"
 
+/**
+ * \brief Animation to be used during some indefinite loading operation.
+ *        Loops along the outside of all segments in a "circle".
+ *        Suppposed to be used as a endlessly looping animation and to be
+ *        stopped by calling the stopLooping method as soon as loading is finished.
+ *
+ */
 extern Animator::ComplexAmination* LoadingAnimation;
 
-#endif
+#endif

lib/LED_clock/Config/Animations/diy-machines/Animations.cpp

@@ -1,8 +1,25 @@
+/**
+ * \file Animations.cpp
+ * \author Florian Laschober
+ * \brief Implementations of all preconfigured animations avaliable.
+ * 		  Simplified animations for 12h Displays without intermediate segments
+ */
+
 #include "Animations.h"
 
 Animator::ComplexAmination* InitLoadingAnimation(uint16_t totalAnimationLength);
+/**
+ * \brief Initialize the animation in global context to make it usable.
+ *
+ */
 Animator::ComplexAmination* LoadingAnimation = InitLoadingAnimation(LOADING_ANIMATION_DURATION);
 
+/**
+ * \brief Initialize the loading animation
+ *
+ * \param totalAnimationLength Duration of the whole animation in milliseconds
+ * \return Animator::ComplexAmination* pointer to the newly created animation
+ */
 Animator::ComplexAmination* InitLoadingAnimation(uint16_t totalAnimationLength)
 {
 	#undef LENGTH
@@ -50,4 +67,4 @@ Animator::ComplexAmination* InitLoadingAnimation(uint16_t totalAnimationLength)
 	animation->LengthPerAnimation 	= totalAnimationLength / allSteps->size();
 	animation->animations 			= allSteps;
 	return animation;
-}
+}

lib/LED_clock/Config/Animations/diy-machines/Animations.h

@@ -1,8 +1,21 @@
+/**
+ * \file Animations.h
+ * \author Florian Laschober
+ * \brief Simplified animations for 12h Displays without intermediate segments
+ */
+
 #ifndef __ANIMATIONS_H_
 #define __ANIMATIONS_H_
 
 #include "DisplayManager.h"
 
+/**
+ * \brief Animation to be used during some indefinite loading operation.
+ *        Loops along the outside of the higher digit hour display in a "circle".
+ *        Suppposed to be used as a endlessly looping animation and to be
+ *        stopped by calling the stopLooping method as soon as loading is finished.
+ *
+ */
 extern Animator::ComplexAmination* LoadingAnimation;
 
-#endif
+#endif