From fc92f9969c1fcc2f952f0bd6d09a309a9b3ce02f Mon Sep 17 00:00:00 2001 From: Dean Camera Date: Thu, 3 Jun 2010 15:32:45 +0000 Subject: Minor documentation cleanups. --- Projects/AVRISP-MKII/Lib/ISP/ISPProtocol.h | 2 +- Projects/AVRISP-MKII/Lib/ISP/ISPTarget.h | 3 +- Projects/AVRISP-MKII/Lib/V2Protocol.h | 8 ++-- Projects/AVRISP-MKII/Lib/V2ProtocolParams.h | 4 +- Projects/AVRISP-MKII/Lib/XPROG/XPROGTarget.h | 4 +- Projects/Benito/Lib/LightweightRingBuff.h | 4 +- Projects/LEDNotifier/Board/LEDs.h | 2 +- Projects/MissileLauncher/ConfigDescriptor.h | 2 +- Projects/MissileLauncher/MissileLauncher.h | 6 +-- Projects/TemperatureDataLogger/TempDataLogger.h | 2 +- Projects/Webserver/Lib/DHCPClientApp.h | 50 ++++++++++++------------- Projects/Webserver/Lib/HTTPServerApp.h | 2 +- Projects/Webserver/Lib/TELNETServerApp.h | 2 +- Projects/Webserver/Webserver.h | 4 +- Projects/XPLAINBridge/Lib/LightweightRingBuff.h | 4 +- 15 files changed, 50 insertions(+), 49 deletions(-) (limited to 'Projects') diff --git a/Projects/AVRISP-MKII/Lib/ISP/ISPProtocol.h b/Projects/AVRISP-MKII/Lib/ISP/ISPProtocol.h index c983f49c6..bc6bb5de1 100644 --- a/Projects/AVRISP-MKII/Lib/ISP/ISPProtocol.h +++ b/Projects/AVRISP-MKII/Lib/ISP/ISPProtocol.h @@ -54,7 +54,7 @@ #endif /* Macros: */ - /** Mask for the reading or writing of the high byte in a FLASH word when issuing a low-level programming command */ + /** Mask for the reading or writing of the high byte in a FLASH word when issuing a low-level programming command. */ #define READ_WRITE_HIGH_BYTE_MASK (1 << 3) #define PROG_MODE_PAGED_WRITES_MASK (1 << 0) diff --git a/Projects/AVRISP-MKII/Lib/ISP/ISPTarget.h b/Projects/AVRISP-MKII/Lib/ISP/ISPTarget.h index 705dd3990..34d623ed7 100644 --- a/Projects/AVRISP-MKII/Lib/ISP/ISPTarget.h +++ b/Projects/AVRISP-MKII/Lib/ISP/ISPTarget.h @@ -56,9 +56,10 @@ #endif /* Macros: */ - /** Total number of allowable ISP programming speeds supported by the device */ + /** Total number of allowable ISP programming speeds supported by the device. */ #define TOTAL_ISP_PROGRAMMING_SPEEDS 7 + /** Low level device command to issue an extended FLASH address, for devices with other 128KB of FLASH. */ #define LOAD_EXTENDED_ADDRESS_CMD 0x4D /* Function Prototypes: */ diff --git a/Projects/AVRISP-MKII/Lib/V2Protocol.h b/Projects/AVRISP-MKII/Lib/V2Protocol.h index d5602a0d4..5b8589294 100644 --- a/Projects/AVRISP-MKII/Lib/V2Protocol.h +++ b/Projects/AVRISP-MKII/Lib/V2Protocol.h @@ -63,16 +63,16 @@ #define _GETADCMUXMASK(x, y) _GETADCMUXMASK2(x, y) #endif - /** Programmer ID string, returned to the host during the CMD_SIGN_ON command processing */ + /** Programmer ID string, returned to the host during the CMD_SIGN_ON command processing. */ #define PROGRAMMER_ID "AVRISP_MK2" - /** Timeout period for each issued command from the host before it is aborted */ + /** Timeout period for each issued command from the host before it is aborted. */ #define COMMAND_TIMEOUT_MS 200 - /** Command timeout counter register, GPIOR for speed */ + /** Command timeout counter register, GPIOR for speed. */ #define TimeoutMSRemaining GPIOR0 - /** MUX mask for the VTARGET ADC channel number */ + /** MUX mask for the VTARGET ADC channel number. */ #define VTARGET_ADC_CHANNEL_MASK _GETADCMUXMASK(ADC_CHANNEL, VTARGET_ADC_CHANNEL) #if !defined(WIN_AVRDUDE_COMPAT) diff --git a/Projects/AVRISP-MKII/Lib/V2ProtocolParams.h b/Projects/AVRISP-MKII/Lib/V2ProtocolParams.h index 4bbb02419..d93aaddbf 100644 --- a/Projects/AVRISP-MKII/Lib/V2ProtocolParams.h +++ b/Projects/AVRISP-MKII/Lib/V2ProtocolParams.h @@ -51,10 +51,10 @@ #include "ISP/ISPTarget.h" /* Macros: */ - /** Parameter privilege mask to allow the host PC to read the parameter's value */ + /** Parameter privilege mask to allow the host PC to read the parameter's value. */ #define PARAM_PRIV_READ (1 << 0) - /** Parameter privilege mask to allow the host PC to change the parameter's value */ + /** Parameter privilege mask to allow the host PC to change the parameter's value. */ #define PARAM_PRIV_WRITE (1 << 1) /** Total number of parameters in the parameter table */ diff --git a/Projects/AVRISP-MKII/Lib/XPROG/XPROGTarget.h b/Projects/AVRISP-MKII/Lib/XPROG/XPROGTarget.h index db233a1a4..3cb73ce90 100644 --- a/Projects/AVRISP-MKII/Lib/XPROG/XPROGTarget.h +++ b/Projects/AVRISP-MKII/Lib/XPROG/XPROGTarget.h @@ -55,10 +55,10 @@ #endif #endif - /** Serial carrier TPI/PDI speed when hardware TPI/PDI mode is used */ + /** Serial carrier TPI/PDI speed when hardware TPI/PDI mode is used. */ #define XPROG_HARDWARE_SPEED 1000000 - /** Total number of bits in a single USART frame */ + /** Total number of bits in a single USART frame. */ #define BITS_IN_USART_FRAME 12 #define PDI_CMD_LDS 0x00 diff --git a/Projects/Benito/Lib/LightweightRingBuff.h b/Projects/Benito/Lib/LightweightRingBuff.h index 31430ddd4..8026cef64 100644 --- a/Projects/Benito/Lib/LightweightRingBuff.h +++ b/Projects/Benito/Lib/LightweightRingBuff.h @@ -41,10 +41,10 @@ #include /* Defines: */ - /** Size of each ring buffer, in bytes */ + /** Size of each ring buffer, in bytes. */ #define BUFFER_SIZE 128 - /** Type of data to store into the buffer */ + /** Type of data to store into the buffer. */ #define RingBuff_Data_t uint8_t /* Type Defines: */ diff --git a/Projects/LEDNotifier/Board/LEDs.h b/Projects/LEDNotifier/Board/LEDs.h index 87dbf6f02..decd2b054 100644 --- a/Projects/LEDNotifier/Board/LEDs.h +++ b/Projects/LEDNotifier/Board/LEDs.h @@ -62,7 +62,7 @@ /** LED mask for all the LEDs on the board. */ #define LEDS_ALL_LEDS (LEDS_LED1 | LEDS_LED2 | LEDS_LED3) - /** LED mask for the none of the board LEDs */ + /** LED mask for the none of the board LEDs. */ #define LEDS_NO_LEDS 0 /* Inline Functions: */ diff --git a/Projects/MissileLauncher/ConfigDescriptor.h b/Projects/MissileLauncher/ConfigDescriptor.h index df21702e5..69983fed8 100644 --- a/Projects/MissileLauncher/ConfigDescriptor.h +++ b/Projects/MissileLauncher/ConfigDescriptor.h @@ -42,7 +42,7 @@ #include "MissileLauncher.h" /* Macros: */ - /** Interface Class value for the Human Interface Device class */ + /** Interface Class value for the Human Interface Device class. */ #define HID_CLASS 0x03 /* Enums: */ diff --git a/Projects/MissileLauncher/MissileLauncher.h b/Projects/MissileLauncher/MissileLauncher.h index 31bb9386f..aba261611 100644 --- a/Projects/MissileLauncher/MissileLauncher.h +++ b/Projects/MissileLauncher/MissileLauncher.h @@ -54,10 +54,10 @@ #include "ConfigDescriptor.h" /* Macros: */ - /** Pipe number for the HID data IN pipe */ + /** Pipe number for the HID data IN pipe. */ #define HID_DATA_IN_PIPE 1 - /** Pipe number for the HID data OUT pipe */ + /** Pipe number for the HID data OUT pipe. */ #define HID_DATA_OUT_PIPE 2 /** HID Class specific request to send a HID report to the device. */ @@ -75,7 +75,7 @@ /** LED mask for the library LED driver, to indicate that an error has occurred in the USB interface. */ #define LEDMASK_USB_ERROR (LEDS_LED1 | LEDS_LED3) - /** Size of the Launcher report command buffer */ + /** Size of the Launcher report command buffer. */ #define LAUNCHER_CMD_BUFFER_SIZE 64 /* Function Prototypes: */ diff --git a/Projects/TemperatureDataLogger/TempDataLogger.h b/Projects/TemperatureDataLogger/TempDataLogger.h index 119ce7658..15b5569fd 100644 --- a/Projects/TemperatureDataLogger/TempDataLogger.h +++ b/Projects/TemperatureDataLogger/TempDataLogger.h @@ -77,7 +77,7 @@ /** Filename for the log data when written to the dataflash FAT filesystem. */ #define LOG_FILENAME "TEMPLOG.txt" - /** Data log interval between samples, in tens of milliseconds */ + /** Data log interval between samples, in tens of milliseconds. */ #define LOG_INTERVAL_10MS 1000 /* Type Defines: */ diff --git a/Projects/Webserver/Lib/DHCPClientApp.h b/Projects/Webserver/Lib/DHCPClientApp.h index d52398325..02d30c8bc 100644 --- a/Projects/Webserver/Lib/DHCPClientApp.h +++ b/Projects/Webserver/Lib/DHCPClientApp.h @@ -44,76 +44,76 @@ #include "../Webserver.h" /* Macros: */ - /** UDP listen port for a BOOTP server */ + /** UDP listen port for a BOOTP server. */ #define DHCPC_SERVER_PORT 67 - /** UDP listen port for a BOOTP client */ + /** UDP listen port for a BOOTP client. */ #define DHCPC_CLIENT_PORT 68 - /** BOOTP message type for a BOOTP REQUEST message */ + /** BOOTP message type for a BOOTP REQUEST message. */ #define DHCP_OP_BOOTREQUEST 0x01 - /** BOOTP message type for a BOOTP REPLY message */ + /** BOOTP message type for a BOOTP REPLY message. */ #define DHCP_OP_BOOTREPLY 0x02 - /** BOOTP flag for a BOOTP broadcast message */ + /** BOOTP flag for a BOOTP broadcast message. */ #define BOOTP_BROADCAST 0x8000 - /** Magic DHCP cookie for a BOOTP message to identify it as a DHCP message */ + /** Magic DHCP cookie for a BOOTP message to identify it as a DHCP message. */ #define DHCP_MAGIC_COOKIE 0x63538263 - /** Unique transaction ID used to identify DHCP responses to the client */ + /** Unique transaction ID used to identify DHCP responses to the client. */ #define DHCP_TRANSACTION_ID 0x13245466 - /** DHCP message type for a DISCOVER message */ + /** DHCP message type for a DISCOVER message. */ #define DHCP_DISCOVER 1 - /** DHCP message type for an OFFER message */ + /** DHCP message type for an OFFER message. */ #define DHCP_OFFER 2 - /** DHCP message type for a REQUEST message */ + /** DHCP message type for a REQUEST message. */ #define DHCP_REQUEST 3 - /** DHCP message type for a DECLINE message */ + /** DHCP message type for a DECLINE message. */ #define DHCP_DECLINE 4 - /** DHCP message type for an ACK message */ + /** DHCP message type for an ACK message. */ #define DHCP_ACK 5 - /** DHCP message type for a NAK message */ + /** DHCP message type for a NAK message. */ #define DHCP_NAK 6 - /** DHCP message type for a RELEASE message */ + /** DHCP message type for a RELEASE message. */ #define DHCP_RELEASE 7 - /** DHCP medium type for standard Ethernet */ + /** DHCP medium type for standard Ethernet. */ #define DHCP_HTYPE_ETHERNET 1 - /** DHCP message option for the network subnet mask */ + /** DHCP message option for the network subnet mask. */ #define DHCP_OPTION_SUBNET_MASK 1 - /** DHCP message option for the network gateway IP */ + /** DHCP message option for the network gateway IP. */ #define DHCP_OPTION_ROUTER 3 - /** DHCP message option for the network DNS server */ + /** DHCP message option for the network DNS server. */ #define DHCP_OPTION_DNS_SERVER 6 - /** DHCP message option for the requested client IP address */ + /** DHCP message option for the requested client IP address. */ #define DHCP_OPTION_REQ_IPADDR 50 - /** DHCP message option for the IP address lease time */ + /** DHCP message option for the IP address lease time. */ #define DHCP_OPTION_LEASE_TIME 51 - /** DHCP message option for the DHCP message type */ + /** DHCP message option for the DHCP message type. */ #define DHCP_OPTION_MSG_TYPE 53 - /** DHCP message option for the DHCP server IP */ + /** DHCP message option for the DHCP server IP. */ #define DHCP_OPTION_SERVER_ID 54 - /** DHCP message option for the list of required options from the server */ + /** DHCP message option for the list of required options from the server. */ #define DHCP_OPTION_REQ_LIST 55 - /** DHCP message option for the options list terminator */ + /** DHCP message option for the options list terminator. */ #define DHCP_OPTION_END 255 /* Type Defines: */ @@ -141,7 +141,7 @@ uint32_t Cookie; /**< Magic BOOTP protocol cookie to indicate a valid packet */ - uint8_t Options[]; /** DHCP message options */ + uint8_t Options[]; /**< DHCP message options */ } DHCP_Header_t; /* Enums: */ diff --git a/Projects/Webserver/Lib/HTTPServerApp.h b/Projects/Webserver/Lib/HTTPServerApp.h index 04cdbe5fe..b30922a76 100644 --- a/Projects/Webserver/Lib/HTTPServerApp.h +++ b/Projects/Webserver/Lib/HTTPServerApp.h @@ -65,7 +65,7 @@ } MIME_Type_t; /* Macros: */ - /** TCP listen port for incoming HTTP traffic */ + /** TCP listen port for incoming HTTP traffic. */ #define HTTP_SERVER_PORT 80 /* Function Prototypes: */ diff --git a/Projects/Webserver/Lib/TELNETServerApp.h b/Projects/Webserver/Lib/TELNETServerApp.h index c42725763..80d48af3b 100644 --- a/Projects/Webserver/Lib/TELNETServerApp.h +++ b/Projects/Webserver/Lib/TELNETServerApp.h @@ -44,7 +44,7 @@ #include /* Macros: */ - /** TCP listen port for incoming TELNET traffic */ + /** TCP listen port for incoming TELNET traffic. */ #define TELNET_SERVER_PORT 23 /* Enums: */ diff --git a/Projects/Webserver/Webserver.h b/Projects/Webserver/Webserver.h index 0643c9b58..970efa26f 100644 --- a/Projects/Webserver/Webserver.h +++ b/Projects/Webserver/Webserver.h @@ -68,10 +68,10 @@ /** LED mask for the library LED driver, to indicate that the USB interface is busy. */ #define LEDMASK_USB_BUSY (LEDS_LED1 | LEDS_LED3 | LEDS_LED4) - /** LED mask for the uIP stack idling with no IP configuration */ + /** LED mask for the uIP stack idling with no IP configuration. */ #define LEDMASK_UIP_READY_NOCONFIG LEDS_LED3 - /** LED mask for the uIP stack idling with a valid IP configuration */ + /** LED mask for the uIP stack idling with a valid IP configuration. */ #define LEDMASK_UIP_READY_CONFIG LEDS_LED4 /* Function Prototypes: */ diff --git a/Projects/XPLAINBridge/Lib/LightweightRingBuff.h b/Projects/XPLAINBridge/Lib/LightweightRingBuff.h index 31430ddd4..8026cef64 100644 --- a/Projects/XPLAINBridge/Lib/LightweightRingBuff.h +++ b/Projects/XPLAINBridge/Lib/LightweightRingBuff.h @@ -41,10 +41,10 @@ #include /* Defines: */ - /** Size of each ring buffer, in bytes */ + /** Size of each ring buffer, in bytes. */ #define BUFFER_SIZE 128 - /** Type of data to store into the buffer */ + /** Type of data to store into the buffer. */ #define RingBuff_Data_t uint8_t /* Type Defines: */ -- cgit v1.2.3