Start doxygen documentation

stm-firmware/doxygen/Doxyconfig

@@ -158,7 +158,7 @@ INLINE_INHERITED_MEMB  = NO
 # shortest path that makes the file name unique will be used
 # The default value is: YES.
 
-FULL_PATH_NAMES        = YES
+FULL_PATH_NAMES        = NO
 
 # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
 # Stripping is only done if one of the specified strings matches the left-hand
@@ -244,7 +244,7 @@ SEPARATE_MEMBER_PAGES  = NO
 # uses this value to replace tabs by spaces in code fragments.
 # Minimum value: 1, maximum value: 16, default value: 4.
 
-TAB_SIZE               = 4
+TAB_SIZE               = 8
 
 # This tag can be used to specify a number of aliases that act as commands in
 # the documentation. An alias has the form:
@@ -569,7 +569,7 @@ CASE_SENSE_NAMES       = NO
 # scope will be hidden.
 # The default value is: NO.
 
-HIDE_SCOPE_NAMES       = NO
+HIDE_SCOPE_NAMES       = YES
 
 # If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will
 # append additional text to a page's title, such as Class Reference. If set to
@@ -829,7 +829,7 @@ WARN_LOGFILE           =
 # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
 # Note: If this tag is empty the current directory is searched.
 
-INPUT                  = .
+INPUT                  = ../
 
 # 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
@@ -917,8 +917,10 @@ RECURSIVE              = YES
 # Note that relative paths are relative to the directory from which doxygen is
 # run.
 
-EXCLUDE                = ../shellmatta \
-                         ../include/stm32
+EXCLUDE                = ../include/stm32 \
+                         ../include/arm_math.h \
+                         ../include/cmsis \
+                         ../shellmatta/test
 
 # 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
@@ -934,7 +936,7 @@ EXCLUDE_SYMLINKS       = NO
 # Note that the wildcards are matched against the file with absolute path, so to
 # exclude all test directories for example use the pattern */test/*
 
-EXCLUDE_PATTERNS       =
+EXCLUDE_PATTERNS       = *.py
 
 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
 # (namespaces, classes, functions, etc.) that should be excluded from the
@@ -1576,7 +1578,7 @@ FORMULA_MACROFILE      =
 # The default value is: NO.
 # This tag requires that the tag GENERATE_HTML is set to YES.
 
-USE_MATHJAX            = NO
+USE_MATHJAX            = YES
 
 # When MathJax is enabled you can set the default output format to be used for
 # the MathJax output. See the MathJax site (see:
@@ -1778,7 +1780,7 @@ PAPER_TYPE             = a4
 # If left blank no extra packages will be included.
 # This tag requires that the tag GENERATE_LATEX is set to YES.
 
-EXTRA_PACKAGES         =
+EXTRA_PACKAGES         = amsmath
 
 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
 # generated LaTeX document. The header should contain everything until the first
@@ -1867,7 +1869,7 @@ LATEX_HIDE_INDICES     = NO
 # The default value is: NO.
 # This tag requires that the tag GENERATE_LATEX is set to YES.
 
-LATEX_SOURCE_CODE      = NO
+LATEX_SOURCE_CODE      = YES
 
 # The LATEX_BIB_STYLE tag can be used to specify the style to use for the
 # bibliography, e.g. plainnat, or ieeetr. See
@@ -1883,7 +1885,7 @@ LATEX_BIB_STYLE        = plain
 # The default value is: NO.
 # This tag requires that the tag GENERATE_LATEX is set to YES.
 
-LATEX_TIMESTAMP        = NO
+LATEX_TIMESTAMP        = YES
 
 # The LATEX_EMOJI_DIRECTORY tag is used to specify the (relative or absolute)
 # path from which the emoji images will be read. If a relative path is entered,

stm-firmware/include/reflow-controller/systick.h

@@ -18,6 +18,10 @@
  * If not, see <http://www.gnu.org/licenses/>.
  */
 
+/**
+ * @file systick.h
+ */
+
 #ifndef __SYSTICK_H__
 #define __SYSTICK_H__
 

stm-firmware/include/stm-periph/dma-ring-buffer.h

@@ -18,6 +18,15 @@
  * If not, see <http://www.gnu.org/licenses/>.
  */
 
+/**
+ * @file dma-ring-buffer.h
+ * @brief Header for DMA Ring buffer implemenation
+ */
+
+/**
+ * @defgroup dma-ring-buffer DMA Ring Buffers from and to Peripherals
+ */
+
 #ifndef __DMA_RING_BUFFER_H__
 #define __DMA_RING_BUFFER_H__
 
@@ -25,6 +34,11 @@
 #include <stm32/stm32f4xx.h>
 #include <stddef.h>
 
+/**
+ * @addtogroup dma-ring-buffer
+ * @{
+ */
+
 /**
  * @brief DMA ring buffer for data transfer from peripheral to memory
  */
@@ -124,6 +138,8 @@ void dma_ring_buffer_mem_to_periph_int_callback(struct dma_ring_buffer_to_periph
  */
 void dma_ring_buffer_mem_to_periph_stop(struct dma_ring_buffer_to_periph *buff);
 
+/** @} */
+
 #endif /* __DMA_RING_BUFFER_H__ */
 
 

stm-firmware/main.c

@@ -18,6 +18,11 @@
  * If not, see <http://www.gnu.org/licenses/>.
  */
 
+/**
+ * @file main.c
+ * @brief Main file for firmware
+ */
+
 #include <stdlib.h>
 #include <string.h>
 /* #include <arm_math.h> */

stm-firmware/stm-periph/dma-ring-buffer.c

@@ -18,6 +18,16 @@
  * If not, see <http://www.gnu.org/licenses/>.
  */
 
+/**
+ * @file dma-ring-buffer.c
+ * @brief DMA Ring buffer implemenation
+ */
+
+/**
+ * @addtogroup dma-ring-buffer
+ * @{
+ */
+
 #include <stm-periph/dma-ring-buffer.h>
 #include <stm-periph/clock-enable-manager.h>
 #include <stdbool.h>
@@ -278,3 +288,5 @@ void dma_ring_buffer_mem_to_periph_stop(struct dma_ring_buffer_to_periph *buff)
 	/* Reset the structure */
 	memset(buff, 0, sizeof(struct dma_ring_buffer_to_periph));
 }
+
+/** @} */

stm-firmware/systick.c

@@ -18,6 +18,10 @@
  * If not, see <http://www.gnu.org/licenses/>.
  */
 
+/**
+ * @file systick.c
+ */
+
 #include <reflow-controller/systick.h>
 #include <stm32/stm32f4xx.h>
 #include <cmsis/core_cm4.h>
@@ -31,14 +35,6 @@ void systick_setup(void)
 	SysTick_Config(SYSTICK_RELOAD);
 }
 
-/**
- * @brief Wait for x milliseconds
- *
- * This function is not reentrant and must not be called from an interrupt
- *
- * @warning Do not use in interrupt context
- * @param ms wait time in ms
- */
 void systick_wait_ms(uint32_t ms)
 {
 	wait_tick_ms = 0UL;