Merge pull request #12 from bxparks/develop

0.6.1 - add missing classes to doxygen docs

Author: bxparks

CHANGELOG.md

@@ -1,6 +1,18 @@
 # Changelog
 
 * Unreleased
+* 0.6.1
+    * Create a second Jenkins continuous build pipeline file
+      `tests/JenskinfileUnitHost` to use UnitHostDuino to run the unit tests
+      natively on Linux. The entire set of unit tests builds and runs in 20
+      seconds under UnixHostduino, compared to about 8 minutes for the single
+      Nano environemnt, and 32 minutes against 4 boards (Nano, ESP8266, ESP32,
+      SAMD21).
+    * Fix Doxygen PREPROCESSOR so that it picks up classes which are enabled
+      only on some environments (e.g. ESP8266, ESP32).
+    * Add circuit schematics to OledClock and WorldClock examples.
+    * Simplify logging::printf() used internally for debugging.
+    * No functional change from 0.6.
 * 0.6
     * Update tests to use `UnixHostDuino`.
     * Fix broken restore functionality in `CommandLineClock`. Make it work

README.md

@@ -112,7 +112,7 @@ The library provides 2 sets of zoneinfo files created from the IANA TZ Database:
   which have (relatively) simple time zone transition rules, and intended to be
   used with the `BasicZoneProcessor` class.
 * [zonedbx/zone_infos.h](src/ace_time/zonedbx/zone_infos.h) contains `kZone*`
-  (e.g. `kZoneAfrica_Casablanca`) declarations for 387 zones and 205 links in
+  declarations (e.g. `kZoneAfrica_Casablanca`) for 387 zones and 205 links in
   the TZ Database (essentially the entire database) intended to be used with
   the `ExtendedZoneProcessor` class.
 
@@ -173,7 +173,7 @@ Normally a small application will use only a small number of timezones. The
 AceTime library with one timezone using the `BasicZoneProcessor` and the
 `SystemClock` consumes:
 * 9-10 kB of flash and 350 bytes of RAM on an 8-bit AVR processors,
-* 6-22 kB of flash and 900-1800 bytes of RAM on an 32-bit processors.
+* 6-22 kB of flash and 900-1800 bytes of RAM on a 32-bit processors.
 
 An example of more complex application is the [WorldClock](examples/WorldClock)
 which has 3 OLED displays over SPI, 3 timezones using `BasicZoneProcessor`, a
@@ -198,10 +198,9 @@ Conversion from an epochSeconds to date-time components including timezone
 * 2.8 microseconds on an ESP32,
 * 6 microseconds on a Teensy 3.2.
 
-**Version**: 0.6 (2019-08-02, TZ DB version 2019a, beta)
+**Version**: 0.6.1 (2019-08-07, TZ DB version 2019a, beta)
 
-**Status**: Fully functional. Added `ZoneManager` for dynamic binding of
-zoneName or zoneId to the TimeZone.
+**Status**: Stable, no major refactoring planned. Expected to go to 1.0 soon.
 
 ## Examples
 
@@ -319,9 +318,9 @@ pacificTime == londonTime: false
 
 ### HelloZoneManager
 
-The [HelloZoneManager](examples/HelloZoneManager) example shows how to load the
-entire TZ Database into a `BasicZoneManager`, then create 3 time zones using 3
-different ways: `createForZoneInfo()`, `createForZoneName()`, and
+The [examples/HelloZoneManager](examples/HelloZoneManager) example shows how to
+load the entire TZ Database into a `BasicZoneManager`, then create 3 time zones
+using 3 different ways: `createForZoneInfo()`, `createForZoneName()`, and
 `createForZoneId()`.
 
 ```C++

USER_GUIDE.md

@@ -2,7 +2,7 @@
 
 See the [README.md](README.md) for introductory background.
 
-Version: 0.6 (2019-08-02, TZ DB version 2019a, beta)
+Version: 0.6.1 (2019-08-07, TZ DB version 2019a, beta)
 
 ## Installation
 
@@ -79,7 +79,7 @@ Linux or MacOS machine, you need:
 ### Doxygen Docs
 
 The [docs/](docs/) directory contains the
-[Doxygen docs on GitHub Pages](https://bxparks.github.io/AceTime/html).
+[Doxygen docs](https://bxparks.github.io/AceTime/html) on GitHub Pages.
 This may be useful to navigate the various classes in this library
 and to lookup the signatures of the methods in those classes.
 

docs/doxygen.cfg

@@ -38,7 +38,7 @@ PROJECT_NAME           = "AceTime"
 # could be handy for archiving the generated documentation or if some version
 # control system is used.
 
-PROJECT_NUMBER         = 0.6
+PROJECT_NUMBER         = 0.6.1
 
 # Using the PROJECT_BRIEF tag one can provide an optional one line description
 # for a project that appears at the top of each page and should give viewer a
@@ -2099,7 +2099,7 @@ INCLUDE_FILE_PATTERNS  =
 # recursively expanded use the := operator instead of the = operator.
 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
 
-PREDEFINED             =
+PREDEFINED             = ARDUINO ESP8266 ACE_ROUTINE_VERSION
 
 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
 # tag can be used to specify a list of macro names that should be expanded. The

docs/html/AceTime_8h_source.html

@@ -22,7 +22,7 @@
  <tr style="height: 56px;">
   <td id="projectalign" style="padding-left: 0.5em;">
    <div id="projectname">AceTime
-   &#160;<span id="projectnumber">0.6</span>
+   &#160;<span id="projectnumber">0.6.1</span>
    </div>
    <div id="projectbrief">Date and time classes for Arduino that support timezones from the TZ Database, and a system clock that can synchronize from an NTP server or an RTC chip.</div>
   </td>