even more doxygen...

Doxygenfile

@@ -45,7 +45,7 @@ PROJECT_BRIEF          =
 # exceed 55 pixels and the maximum width should not exceed 200 pixels.
 # Doxygen will copy the logo to the output directory.
 
-PROJECT_LOGO           = docs/rsc/logo.png 
+PROJECT_LOGO           = 
 
 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
 # base path where the generated documentation will be put.

include/console.h

@@ -18,6 +18,14 @@
     along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
+/**
+ * @file	include/console.h
+ * @brief	CONSOLE header file.
+ *
+ * @addtogroup CONSOLE
+ * @{
+ */
+
 #ifndef CONSOLE_H
 #define CONSOLE_H
 
@@ -81,4 +89,5 @@ msg_t gfxConsoleWrite(GConsole *console, const uint8_t *bp, size_t n);
 #endif /* GFX_USE_CONSOLE */
 
 #endif /* CONSOLE_H */
+/** @} */
 

include/gdisp.h

@@ -17,13 +17,15 @@
     You should have received a copy of the GNU General Public License
     along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
+
 /**
- * @file    gdisp.h
+ * @file    include/gdisp.h
  * @brief   GDISP Graphic Driver subsystem header file.
  *
  * @addtogroup GDISP
  * @{
  */
+
 #ifndef _GDISP_H
 #define _GDISP_H
 
@@ -317,3 +319,4 @@ void gdispDrawBox(coord_t x, coord_t y, coord_t cx, coord_t cy, color_t color);
 
 #endif /* _GDISP_H */
 /** @} */
+

include/gdisp_emulation.c

@@ -767,3 +767,4 @@ void *GDISP_LLD(query)(unsigned what) {
 
 #endif  /* GFX_USE_GDISP */
 #endif	/* GDISP_EMULATION_C */
+

include/gdisp_fonts.h

@@ -17,8 +17,9 @@
     You should have received a copy of the GNU General Public License
     along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
+
 /**
- * @file    gdisp_fonts.h
+ * @file    include/gdisp_fonts.h
  * @brief   GDISP internal font definitions.
  * @details	This is not generally needed by an application. It is used
  * 			by the low level drivers that need to understand a font.
@@ -88,3 +89,4 @@ struct font {
 
 #endif /* _GDISP_FONTS_H */
 /** @} */
+

include/gdisp_lld.h

@@ -17,8 +17,9 @@
     You should have received a copy of the GNU General Public License
     along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
+
 /**
- * @file    gdisp_lld.h
+ * @file    include/gdisp_lld.h
  * @brief   GDISP Graphic Driver subsystem low level driver header.
  *
  * @addtogroup GDISP
@@ -648,3 +649,4 @@ extern "C" {
 
 #endif	/* _GDISP_LLD_H */
 /** @} */
+

include/gdisp_lld_msgs.h

@@ -17,8 +17,9 @@
     You should have received a copy of the GNU General Public License
     along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
+
 /**
- * @file    gdisp_lld_msgs.h
+ * @file    include/gdisp_lld_msgs.h
  * @brief   GDISP Graphic Driver subsystem low level driver message structures.
  *
  * @addtogroup GDISP
@@ -191,3 +192,4 @@ typedef union gdisp_lld_msg {
 #endif	/* GFX_USE_GDISP */
 #endif	/* _GDISP_LLD_MSGS_H */
 /** @} */
+

include/graph.h

@@ -17,13 +17,15 @@
     You should have received a copy of the GNU General Public License
     along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
+
 /**
- * @file	graph.h
+ * @file	include/graph.h
  * @brief	GRAPH module header file.
  *
  * @addtogroup GRAPH
  * @{
  */
+
 #ifndef GRAPH_H
 #define GRAPH_H
 

include/touchpad.h

@@ -19,12 +19,13 @@
 */
 
 /**
- * @file	touchpad.h
+ * @file	include/touchpad.h
  * @brief	TOUCHPAD Touchpad Driver subsystem header file.
  *
  * @addtogroup TOUCHPAD
  * @{
  */
+
 #ifndef _TOUCHPAD_H
 #define _TOUCHPAD_H
 

include/touchpad_lld.h

@@ -19,7 +19,7 @@
 */
 
 /**
- * @file	touchpad_lld.h
+ * @file	include/touchpad_lld.h
  * @brief	TOUCHPAD Driver subsystem low level driver header.
  *
  * @addtogroup TOUCHPAD

src/console.c

@@ -18,11 +18,19 @@
     along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
+/**
+ * @file	src/console.c
+ * @brief	CONSOLE code.
+ *
+ * @addtogroup CONSOLE
+ * @{
+ */
+
 #include "ch.h"
 #include "hal.h"
 #include "console.h"
 
-#if GFX_USE_CONSOLE
+#if GFX_USE_CONSOLE || defined(__DOXYGEN__)
 
 /*
  * Interface implementation. The interface is write only
@@ -86,6 +94,18 @@ static const struct GConsoleVMT vmt = {
 	putt, gett, writet, readt
 };
 
+/**
+ * @brief	Initializes a console.
+ *
+ * @param[in] console			The console driver struct
+ * @param[in] x0,y0				The location of the upper left corner of the resulting window
+ * @param[in] width, height		The width and height of the window
+ * @param[in] font				The font to be used when printing to the console
+ * @param[in] bkcolor			The background color
+ * @param[in] color				The foreground / font color
+ *
+ * @return						RDY_OK if done
+ */
 msg_t gfxConsoleInit(GConsole *console, coord_t x0, coord_t y0, coord_t width, coord_t height, font_t font, pixel_t bkcolor, pixel_t color) {
 	console->vmt = &vmt;
 	/* read font, get height & padding */
@@ -110,6 +130,14 @@ msg_t gfxConsoleInit(GConsole *console, coord_t x0, coord_t y0, coord_t width, c
 	return RDY_OK;
 }
 
+/**
+ * @brief	Write a single character to the console.
+ *
+ * @param[in] console	The console driver struct
+ * @param[in] c			The char to be written
+ *
+ * @return				RDY_OK if done
+ */
 msg_t gfxConsolePut(GConsole *console, char c) {
 	uint8_t width;
 
@@ -164,6 +192,17 @@ msg_t gfxConsolePut(GConsole *console, char c) {
 	return RDY_OK;
 }
 
+/**
+ * @brief	Write a string to the console.
+ *
+ * @param[in] console	The console driver struct
+ * @param[in] bp		The buffer / string
+ * @param[in] n			The size of the buffer
+ *
+ * @return				RDY_OK if done
+ *
+ * @api
+ */
 msg_t gfxConsoleWrite(GConsole *console, const uint8_t *bp, size_t n) {
 	size_t i;
 	for(i = 0; i < n; i++)
@@ -172,5 +211,6 @@ msg_t gfxConsoleWrite(GConsole *console, const uint8_t *bp, size_t n) {
 	return RDY_OK;
 }
 
-#endif 
+#endif /* GFX_USE_CONSOLE */
+/** @} */
 

src/gdisp-readme.txt

@@ -1,14 +0,0 @@
-The new GDISP driver is an architecture independent rewrite of the GLCD interface.
-This new architecture independence should allow many new low level drivers to be easily added.
-
-GDISP allows low-level driver hardware accelerated drawing routines while providing a software emulation
-if the low level driver can not provide it. A basic low level driver now only requires 2 routines to be written.
-
-A glcd.h compatibility file has been included that allow applications written to use the existing GLCD driver to
-use the GDISP driver with little or no change.
-
-It is written in the ChibiOS style with ChibiOS style includes and documentation.
-
-It is encapsulated into a "halext" structure with appropriate readme's that allow for easy inclusion in any
-ChibiOS project. This structure can be seamlessly added to as new driver types are added and it supports
-low level drivers that are neither platform or board specific (although they can be).

src/gdisp.c

@@ -19,7 +19,7 @@
 */
 
 /**
- * @file    gdisp.c
+ * @file    src/gdisp.c
  * @brief   GDISP Driver code.
  *
  * @addtogroup GDISP

src/gdisp_fonts.c

@@ -17,6 +17,7 @@
     You should have received a copy of the GNU General Public License
     along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
+
 /*
 	Font tables included into gdisp.c
 */
@@ -653,3 +654,4 @@
 #endif /* GDISP_NEED_TEXT */
 
 #endif /* GFX_USE_GDISP */
+

src/graph.c

@@ -19,7 +19,7 @@
 */
 
 /**
- * @file	graph.c
+ * @file	src/graph.c
  * @brief	GRAPH module code.
  *
  * @addtogroup GRAPH

src/gwin.c

@@ -19,7 +19,7 @@
 */
 
 /**
- * @file    gwin.c
+ * @file    src/gwin.c
  * @brief   GWIN Driver code.
  *
  * @addtogroup GWIN
@@ -888,3 +888,4 @@ void gwinButtonDraw(GHandle gh) {
 
 #endif /* _GWIN_C */
 /** @} */
+

src/touchpad.c

@@ -18,12 +18,13 @@
 */
 
 /**
- * @file	touchpad.c
+ * @file	src/touchpad.c
  * @brief	Touchpad Driver code.
  *
  * @addtogroup TOUCHPAD
  * @{
  */
+
 #include "ch.h"
 #include "hal.h"
 #include "gdisp.h"