Added a basic doxygen configuration.

neopixel.cc

@@ -23,7 +23,7 @@
 
 extern Serial serial;
 
-// Initialise the hardware.
+/// Initialise the hardware.
 void NeoPixel::init() {
     DDRB |= _BV(1);
     TCCR0A = _BV(WGM01) | _BV(WGM00) | _BV(COM0B1) | _BV(COM0B0);
@@ -34,13 +34,13 @@ void NeoPixel::init() {
     OCR0B = Low;
 }
 
-// Set all the LEDs to off and restart at the first LED.
+/// Set all the LEDs to off and restart at the first LED.
 void NeoPixel::clear() {
     p_ = bits_;
     memset(bits_, Low, sizeof(bits_));
 }
 
-// Append a byte to the stream.
+/// Append a byte to the stream.
 void NeoPixel::append(uint8_t b) {
     if (p_ <= (bits_ + sizeof(bits_) - Tail - BitsPerColour)) {
         for (auto i = 0; i < BitsPerColour; i++) {
@@ -50,7 +50,7 @@ void NeoPixel::append(uint8_t b) {
     }
 }
 
-// Write to the LEDs.
+/// Write to the LEDs.
 void NeoPixel::write() {
     bits_[sizeof(bits_) - 1] = Stop;
 

neopixel.h

@@ -18,8 +18,10 @@
 
 #include <stdint.h>
 
-// NeoPixel ring driver.
-//
+/// NeoPixel ring driver.
+///
+/// Implemented as a bit-banged loop.
+///
 class NeoPixel {
    public:
     NeoPixel() { clear(); }

ser2neo.cc

@@ -20,7 +20,11 @@
 #include "neopixel.h"
 #include "serial.h"
 
-// Main application class.
+/// Main application class.
+///
+/// Reads commands from the serial port, processes them, and
+/// responds.
+///
 class Ser2Neo {
    public:
     void init();
@@ -33,18 +37,19 @@ class Ser2Neo {
     int read_escaped();
     void read_leds();
     void wait_eol();
-    void send_ok(const char* msg);
+    void send_ok(const char* msg=nullptr);
 
     NeoPixel leds;
     Serial serial;
 };
 
+/// Initialise the hardware.
 void Ser2Neo::init() {
     leds.init();
     serial.init();
 }
 
-// Read a character, de-escaping if required.
+/// Read a character, de-escaping if required.
 int Ser2Neo::read_escaped() {
     auto got = serial.getch();
     if (got == EOF) {
@@ -60,7 +65,7 @@ int Ser2Neo::read_escaped() {
     return got;
 }
 
-// Read the (potentially escaped) LED levels.
+/// Read the (potentially escaped) LED levels.
 void Ser2Neo::read_leds() {
     leds.clear();
     while (true) {
@@ -72,13 +77,13 @@ void Ser2Neo::read_leds() {
     }
 }
 
-// Wait until the end-of-line character is received.
+/// Wait until the end-of-line character is received.
 void Ser2Neo::wait_eol() {
     while (serial.getch() != EOF) {
     }
 }
 
-// Send OK with an optional message.
+/// Send OK with an optional message.
 void Ser2Neo::send_ok(const char* msg) {
     wait_eol();
     serial.putstr("OK");
@@ -89,7 +94,7 @@ void Ser2Neo::send_ok(const char* msg) {
     serial.putstr("\n");
 }
 
-// Run the main loop.  Process and run commands.
+/// Run the main loop.  Process and run commands.
 void Ser2Neo::run() {
     sei();
 

ser2neo.dox

@@ -0,0 +1,15 @@
+# A basic Doxygen configuration.
+PROJECT_NAME           = "ser2neo"
+PROJECT_NUMBER         =
+PROJECT_BRIEF          =
+PROJECT_LOGO           =
+OUTPUT_DIRECTORY       = doc
+BRIEF_MEMBER_DESC      = YES
+JAVADOC_AUTOBRIEF      = YES
+BUILTIN_STL_SUPPORT    = YES
+QUIET                  = YES
+RECURSIVE              = NO
+GENERATE_HTML          = YES
+HTML_OUTPUT            = html
+GENERATE_HTMLHELP      = NO
+GENERATE_LATEX         = NO

serial.cc

@@ -25,7 +25,7 @@ Serial* Serial::instance_;
 #define _clear(port, pin) port &= ~_BV(pin)
 #define _set(port, pin) port |= _BV(pin)
 
-// Initialise the hardware.
+/// Initialise the hardware.
 void Serial::init() {
     state_ = Idle;
     rx_full_ = false;
@@ -51,7 +51,7 @@ void Serial::init() {
     _set(GIMSK, PCIE);
 }
 
-// Handle the pin change interrupt by starting receive.
+/// Handle the pin change interrupt by starting receive.
 void Serial::pcint0() {
     _clear(PCMSK, RxPin);
     _clear(TIMSK, TOV1);  // PENDING
@@ -66,7 +66,7 @@ void Serial::pcint0() {
     _set(TIMSK, TOV1);
 }
 
-// Handle the timer overflow interrupt by doing the next bit.
+/// Handle the timer overflow interrupt by doing the next bit.
 inline void Serial::timer1ovf() {
     switch (state_) {
         case Receive: {
@@ -106,7 +106,7 @@ inline void Serial::timer1ovf() {
     }
 }
 
-// Wait until the hardware is free then start the transmit.
+/// Wait until the hardware is free then start the transmit.
 void Serial::putch(uint8_t ch) {
     while (state_ != Idle) {
         sleep_cpu();
@@ -119,14 +119,14 @@ void Serial::putch(uint8_t ch) {
     _set(TIMSK, TOV1);
 }
 
-// Send a string.
+/// Send a string.
 void Serial::putstr(const char* str) {
     for (; *str != '\0'; str++) {
         putch(*str);
     }
 }
 
-// Wait until a character is received, then return it.
+/// Wait until a character is received, then return it.
 uint8_t Serial::getch() {
     while (!rx_full_) {
         sleep_cpu();

serial.h

@@ -18,10 +18,10 @@
 
 #include <stdint.h>
 
-// Half-duplex interrupt based serial port.
-//
-// Loosely based on AVR304.
-//
+/// Half-duplex interrupt based serial port.
+///
+/// Loosely based on AVR304.
+///
 class Serial {
    public:
     void init();