From ae09939eb8c62c83f244527e7916cee5f9145e6c Mon Sep 17 00:00:00 2001 From: travisutk Date: Sun, 20 Sep 2009 19:13:45 +0000 Subject: [PATCH] Doxygen stuff. git-svn-id: https://svn.code.sf.net/p/goodfet/code/trunk@147 12e2690d-a6be-4b82-a7b7-67c4a43b65c8 --- firmware/Doxyfile | 10 +++++----- firmware/apps/chipcon/chipcon.c | 4 +--- firmware/apps/i2c/i2c.c | 5 +---- firmware/apps/jtag/jtag.c | 6 +----- firmware/apps/jtag/jtag430.c | 6 +----- firmware/apps/jtag/jtag430x2.c | 8 ++------ firmware/apps/monitor/monitor.c | 4 +--- firmware/apps/spi/spi.c | 4 +--- firmware/goodfet.c | 1 + firmware/include/apps.h | 5 ++++- firmware/include/chipcon.h | 5 ++++- firmware/include/command.h | 8 ++++++-- firmware/include/jtag.h | 4 ++++ firmware/include/monitor.h | 5 ++++- firmware/include/platform.h | 8 +++++++- firmware/include/spi.h | 5 ++++- firmware/lib/command.c | 10 +++++++--- 17 files changed, 54 insertions(+), 44 deletions(-) diff --git a/firmware/Doxyfile b/firmware/Doxyfile index 0e5d99b..24e1560 100644 --- a/firmware/Doxyfile +++ b/firmware/Doxyfile @@ -974,7 +974,7 @@ FORMULA_FONTSIZE = 10 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will # generate Latex output. -GENERATE_LATEX = YES +GENERATE_LATEX = NO # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. # If a relative path is entered the value of OUTPUT_DIRECTORY will be @@ -1125,7 +1125,7 @@ MAN_LINKS = NO # generate an XML file that captures the structure of # the code including all documentation. -GENERATE_XML = NO +GENERATE_XML = YES # The XML_OUTPUT tag is used to specify where the XML pages will be put. # If a relative path is entered the value of OUTPUT_DIRECTORY will be @@ -1343,7 +1343,7 @@ HIDE_UNDOC_RELATIONS = YES # toolkit from AT&T and Lucent Bell Labs. The other options in this section # have no effect if this option is set to NO (the default) -HAVE_DOT = NO +HAVE_DOT = YES # By default doxygen will write a font called FreeSans.ttf to the output # directory and reference it in all dot files that doxygen generates. This @@ -1418,7 +1418,7 @@ INCLUDED_BY_GRAPH = YES # the time of a run. So in most cases it will be better to enable call graphs # for selected functions only using the \callgraph command. -CALL_GRAPH = NO +CALL_GRAPH = YES # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then # doxygen will generate a caller dependency graph for every global function @@ -1426,7 +1426,7 @@ CALL_GRAPH = NO # the time of a run. So in most cases it will be better to enable caller # graphs for selected functions only using the \callergraph command. -CALLER_GRAPH = NO +CALLER_GRAPH = YES # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen # will graphical hierarchy of all classes instead of a textual one. diff --git a/firmware/apps/chipcon/chipcon.c b/firmware/apps/chipcon/chipcon.c index b57b01f..7b55db8 100644 --- a/firmware/apps/chipcon/chipcon.c +++ b/firmware/apps/chipcon/chipcon.c @@ -1,8 +1,6 @@ /*! \file chipcon.c \author Travis Goodspeed - - This is an implementation of the Chipcon 8051 - debugging protocol for the GoodFET. + \brief Chipcon 8051 debugging. */ diff --git a/firmware/apps/i2c/i2c.c b/firmware/apps/i2c/i2c.c index 462a2cf..6ee1623 100644 --- a/firmware/apps/i2c/i2c.c +++ b/firmware/apps/i2c/i2c.c @@ -1,9 +1,6 @@ /*! \file i2c.c \author Travis Goodspeed - - GoodFET I2C Master Application - Handles basic I/O - + \brief I2C Master */ diff --git a/firmware/apps/jtag/jtag.c b/firmware/apps/jtag/jtag.c index cf9199d..d28a02f 100644 --- a/firmware/apps/jtag/jtag.c +++ b/firmware/apps/jtag/jtag.c @@ -1,10 +1,6 @@ /*! \file jtag.c \author Travis Goodspeed - - This is an implementation of the low-level JTAG functions - for the GoodFET project at http://goodfet.sf.net/ - - See the license file for details of proper use. + \brief Low-level JTAG */ diff --git a/firmware/apps/jtag/jtag430.c b/firmware/apps/jtag/jtag430.c index 215ab99..d937b4d 100644 --- a/firmware/apps/jtag/jtag430.c +++ b/firmware/apps/jtag/jtag430.c @@ -1,10 +1,6 @@ /*! \file jtag430.c \author Travis Goodspeed - - This is an implementation of the 16-bit MSP430 JTAG protocol - for the GoodFET project at http://goodfet.sf.net/ - - See the license file for details of proper use. + \brief MSP430 JTAG (16-bit) */ #include "platform.h" diff --git a/firmware/apps/jtag/jtag430x2.c b/firmware/apps/jtag/jtag430x2.c index d0f5709..432c725 100644 --- a/firmware/apps/jtag/jtag430x2.c +++ b/firmware/apps/jtag/jtag430x2.c @@ -1,10 +1,6 @@ /*! \file jtag430x2.c \author Travis Goodspeed - - This is an implementation of the MSP430X2 JTAG protocol - for the GoodFET project at http://goodfet.sf.net/ - - See the license file for details of proper use. + \brief MSP430X2 JTAG (20-bit) */ #include "platform.h" @@ -94,7 +90,7 @@ void jtag430x2_writemem(unsigned long adr, //! Read data from address unsigned int jtag430x2_readmem(unsigned long adr){ unsigned int toret=0; - unsigned int tries=5; + //unsigned int tries=5; while(1){ do{ diff --git a/firmware/apps/monitor/monitor.c b/firmware/apps/monitor/monitor.c index 1263bcb..8828491 100644 --- a/firmware/apps/monitor/monitor.c +++ b/firmware/apps/monitor/monitor.c @@ -1,8 +1,6 @@ /*! \file monitor.c \author Travis Goodspeed - - This is an implementation of the SPI protocol - for the GoodFET project. + \brief Local debug monitor. */ #include "command.h" diff --git a/firmware/apps/spi/spi.c b/firmware/apps/spi/spi.c index 6fe0151..94fbf0e 100644 --- a/firmware/apps/spi/spi.c +++ b/firmware/apps/spi/spi.c @@ -1,8 +1,6 @@ /*! \file spi.c \author Travis Goodspeed - - This is an implementation of the SPI protocol - for the GoodFET project. + \brief SPI Master */ //Higher level left to client application. diff --git a/firmware/goodfet.c b/firmware/goodfet.c index bf63b13..d09683c 100644 --- a/firmware/goodfet.c +++ b/firmware/goodfet.c @@ -1,5 +1,6 @@ /*! \file goodfet.c \author Travis Goodspeed + \brief Main module. This is the main module of the GoodFET, which calls the initialization routines and delegates commands to the various applications. diff --git a/firmware/include/apps.h b/firmware/include/apps.h index 691e0d0..4835e14 100644 --- a/firmware/include/apps.h +++ b/firmware/include/apps.h @@ -1,4 +1,7 @@ -//! Application stuff. +/*! \file apps.h + \author Travis Goodspeed + \brief Application definitions. +*/ #define MONITOR 0x00 #define SPI 0x01 diff --git a/firmware/include/chipcon.h b/firmware/include/chipcon.h index 9232074..ece1e53 100644 --- a/firmware/include/chipcon.h +++ b/firmware/include/chipcon.h @@ -1,4 +1,7 @@ -//These high-level functions are implemented in chipcon.c. +/*! \file chipcon.h + \author Travis Goodspeed + \brief Chipcon application functions. +*/ //! Erase a chipcon chip. diff --git a/firmware/include/command.h b/firmware/include/command.h index 3be397e..ad0ad15 100644 --- a/firmware/include/command.h +++ b/firmware/include/command.h @@ -1,7 +1,11 @@ -// Command handling functions. +/*! \file command.h + \author Travis Goodspeed + \brief Command codes and buffers. +*/ //! Global data buffer. extern unsigned char cmddata[256]; + #define cmddataword ((unsigned int*) cmddata) #define cmddatalong ((unsigned long*) cmddata) #define memorybyte ((unsigned char*) 0) @@ -98,7 +102,7 @@ void txstring(unsigned char app, //! Transmit a debug string. void debugstr(const char *str); -//! Delay +//! Delay for a count. void delay(unsigned int count); //! MSDelay void msdelay(unsigned int ms); diff --git a/firmware/include/jtag.h b/firmware/include/jtag.h index a766b06..5dd5675 100644 --- a/firmware/include/jtag.h +++ b/firmware/include/jtag.h @@ -1,3 +1,7 @@ +/*! \file jtag.h + \author Travis Goodspeed + \brief JTAG handler functions. +*/ #include #include diff --git a/firmware/include/monitor.h b/firmware/include/monitor.h index 3a89422..8c48600 100644 --- a/firmware/include/monitor.h +++ b/firmware/include/monitor.h @@ -1,4 +1,7 @@ - +/*! \file monitor.h + \author Travis Goodspeed + \brief Debug monitor commands. +*/ #include #include diff --git a/firmware/include/platform.h b/firmware/include/platform.h index 16b3e84..5de88ca 100644 --- a/firmware/include/platform.h +++ b/firmware/include/platform.h @@ -1,4 +1,10 @@ -//! \file platform.h +/*! \file platform.h + \author Travis Goodspeed + \brief Port and baud rate definitions. + + The functions specified here are defined in the platform + definition file, such as msp430x1612.c or msp430x2618.c. +*/ #include #include diff --git a/firmware/include/spi.h b/firmware/include/spi.h index 8cd488a..c39766d 100644 --- a/firmware/include/spi.h +++ b/firmware/include/spi.h @@ -1,4 +1,7 @@ -/** SPI **/ +/*! \file spi.h + \author Travis Goodspeed + \brief Definitions for the SPI application. +*/ //Pins and I/O diff --git a/firmware/lib/command.c b/firmware/lib/command.c index 6d72108..afeb3f9 100644 --- a/firmware/lib/command.c +++ b/firmware/lib/command.c @@ -1,7 +1,6 @@ /*! \file command.c \author Travis Goodspeed - - These functions manage command interpretation. + \brief These functions manage command interpretation. */ #include "command.h" @@ -23,7 +22,12 @@ void txstring(unsigned char app, serial_tx(*(str++)); } -//! Transmits a debugging string out of line. +/*! \brief Transmit a debug string. + + Transmits a debugging string that is to be printed + out of line by the client. This is just for record-keeping; + it is not considered a proper reply to a query. + */ void debugstr(const char *str){ txstring(0xFF,0xFF,str); } -- 2.20.1