ahoneybun/qmk_firmware
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Minor documentation cleanups.

Browse source
This commit is contained in:
Dean Camera 2010-06-03 15:32:45 +00:00
parent 9293de2491
commit fc92f9969c
109 changed files with 473 additions and 434 deletions
Download patch file Download diff file Expand all files Collapse all files

2
Projects/AVRISP-MKII/Lib/ISP/ISPProtocol.h
View file

@ -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)

3
Projects/AVRISP-MKII/Lib/ISP/ISPTarget.h
View file

@ -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: */

8
Projects/AVRISP-MKII/Lib/V2Protocol.h
View file

@ -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)

4
Projects/AVRISP-MKII/Lib/V2ProtocolParams.h
View file

@ -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 */

4
Projects/AVRISP-MKII/Lib/XPROG/XPROGTarget.h
View file

@ -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

4
Projects/Benito/Lib/LightweightRingBuff.h
View file

@ -41,10 +41,10 @@
#include <stdbool.h>
/* 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: */

2
Projects/LEDNotifier/Board/LEDs.h
View file

@ -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: */

2
Projects/MissileLauncher/ConfigDescriptor.h
View file

@ -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: */

6
Projects/MissileLauncher/MissileLauncher.h
View file

@ -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: */

2
Projects/TemperatureDataLogger/TempDataLogger.h
View file

@ -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: */

50
Projects/Webserver/Lib/DHCPClientApp.h
View file

@ -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: */

2
Projects/Webserver/Lib/HTTPServerApp.h
View file

@ -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: */

2
Projects/Webserver/Lib/TELNETServerApp.h
View file

@ -44,7 +44,7 @@
#include <uip.h>
/* Macros: */
/** TCP listen port for incoming TELNET traffic */
/** TCP listen port for incoming TELNET traffic. */
#define TELNET_SERVER_PORT 23
/* Enums: */

4
Projects/Webserver/Webserver.h
View file

@ -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: */

4
Projects/XPLAINBridge/Lib/LightweightRingBuff.h
View file

@ -41,10 +41,10 @@
#include <stdbool.h>
/* 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: */