Start doxygen documentation

stm-firmware/Makefile

@@ -15,7 +15,7 @@ LIBRARIES = -larm_cortexM4lf_math -lm
 DEFINES = -DSTM32F407xx -DSTM32F4XX -DARM_MATH_CM4 -DHSE_VALUE=8000000UL
 mapfile = memory-mapping
 
-GIT_VER := $(shell git describe --always --dirty --tags)
+export GIT_VER = $(shell git describe --always --dirty --tags)
 DEFINES += -DGIT_VER=$(GIT_VER)
 
 ifneq ($(VERBOSE),true)
@@ -81,6 +81,7 @@ $(target).elf: $(OBJ) $(ASOBJ)
 	@echo [LD] $@
 	$(QUIET)$(CC) $(LFLAGS) $(LIBRARYPATH) -o $@ $^ $(LIBRARIES)
 	$(QUIET)$(SIZE) $@
+	@echo "Built Version $(GIT_VER)"
 
 #Compiling
 $(OBJ):

stm-firmware/doxygen/build-doxygen.sh

@@ -0,0 +1,20 @@
+#!/bin/bash
+
+SOURCE="${BASH_SOURCE[0]}"
+while [ -h "$SOURCE" ]; do # resolve $SOURCE until the file is no longer a symlink
+  DIR="$( cd -P "$( dirname "$SOURCE" )" >/dev/null && pwd )"
+  SOURCE="$(readlink "$SOURCE")"
+  [[ $SOURCE != /* ]] && SOURCE="$DIR/$SOURCE" # if $SOURCE was a relative symlink, we need to resolve it relative to the path where the symlink file was located
+done
+DIR="$( cd -P "$( dirname "$SOURCE" )" >/dev/null && pwd )"
+cd "$DIR"
+
+export PROJECT_NUMBER=`git describe --always --tags --dirty`
+
+if [ $# != 1 ]; then
+	export OUTPUT_DIRECTORY="./output"
+else
+	export OUTPUT_DIRECTORY="$1"
+fi
+
+doxygen Doxyconfig

stm-firmware/doxygen/output/.gitignore

@@ -0,0 +1,3 @@
+*
+*/
+!.gitignore

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;