ceedling 0.25.0 → 0.27.0

data/vendor/cmock/{targets → test/targets}/gcc_64.yml

@@ -1,10 +1,10 @@
 ---
 compiler:
   path: gcc
-  source_path:     &systest_generated_path 'test/system/generated/'
-  unit_tests_path: &unit_tests_path 'examples/test/'
-  mocks_path:      &systest_mocks_path 'test/system/generated/'
-  build_path:      &systest_build_path 'test/system/build/'
+  source_path:     &systest_generated_path './system/generated/'
+  unit_tests_path: &unit_tests_path '../examples/test/'
+  mocks_path:      &systest_mocks_path './system/generated/'
+  build_path:      &systest_build_path './system/build/'
   options:
     - '-c'
     - '-m64'
@@ -20,11 +20,11 @@ compiler:
       - *systest_generated_path
       - *unit_tests_path
       - *systest_mocks_path
-      - 'src/'
-      - 'vendor/unity/src/'
-      - 'vendor/c_exception/lib/'
-      - 'test/system/test_compilation/'
-      - 'test/'
+      - '../src/'
+      - '../vendor/unity/src/'
+      - '../vendor/c_exception/lib/'
+      - './system/test_compilation/'
+      - './'
   defines:
     prefix: '-D'
     items:

data/vendor/cmock/{targets → test/targets}/gcc_tiny.yml

@@ -1,10 +1,10 @@
 ---
 compiler:
   path: gcc
-  source_path:     &systest_generated_path 'test/system/generated/'
-  unit_tests_path: &unit_tests_path 'examples/test/'
-  mocks_path:      &systest_mocks_path 'test/system/generated/'
-  build_path:      &systest_build_path 'test/system/build/'
+  source_path:     &systest_generated_path './system/generated/'
+  unit_tests_path: &unit_tests_path '../examples/test/'
+  mocks_path:      &systest_mocks_path './system/generated/'
+  build_path:      &systest_build_path './system/build/'
   options:
     - '-c'
     - '-Wall'
@@ -21,11 +21,11 @@ compiler:
       - *systest_generated_path
       - *unit_tests_path
       - *systest_mocks_path
-      - 'src/'
-      - 'vendor/unity/src/'
-      - 'vendor/c_exception/lib/'
-      - 'test/system/test_compilation/'
-      - 'test/'
+      - '../src/'
+      - '../vendor/unity/src/'
+      - '../vendor/c_exception/lib/'
+      - './system/test_compilation/'
+      - './'
   defines:
     prefix: '-D'
     items:

data/vendor/cmock/{targets → test/targets}/iar_arm_v4.yml

@@ -1,10 +1,10 @@
 tools_root: &tools_root 'C:\Program Files\IAR Systems\Embedded Workbench 4.0\'
 compiler:
   path:             [*tools_root, 'arm\bin\iccarm.exe']
-  source_path:     &systest_generated_path 'test/system/generated/'
-  unit_tests_path: &unit_tests_path 'examples/test/'
-  mocks_path:      &systest_mocks_path 'test/system/generated/'
-  build_path:      &systest_build_path 'test/system/build/'
+  source_path:     &systest_generated_path './system/generated/'
+  unit_tests_path: &unit_tests_path '../examples/test/'
+  mocks_path:      &systest_mocks_path './system/generated/'
+  build_path:      &systest_build_path './system/build/'
   options:
     - --dlib_config
     - [*tools_root, 'arm\lib\dl4tptinl8n.h']
@@ -38,11 +38,11 @@ compiler:
       - *systest_generated_path
       - *unit_tests_path
       - *systest_mocks_path
-      - 'src/'
-      - 'vendor/unity/src/'
-      - 'vendor/c_exception/lib/'
-      - 'test/system/test_compilation/'
-      - 'test\'
+      - '../src/'
+      - '../vendor/unity/src/'
+      - '../vendor/c_exception/lib/'
+      - './system/test_compilation/'
+      - './'
   defines:
     prefix: '-D'
     items:

data/vendor/cmock/{targets → test/targets}/iar_arm_v5.yml

@@ -1,10 +1,10 @@
 tools_root: &tools_root 'C:\Program Files\IAR Systems\Embedded Workbench 5.3\'
 compiler:
   path:             [*tools_root, 'arm\bin\iccarm.exe']
-  source_path:     &systest_generated_path 'test/system/generated/'
-  unit_tests_path: &unit_tests_path 'examples/test/'
-  mocks_path:      &systest_mocks_path 'test/system/generated/'
-  build_path:      &systest_build_path 'test/system/build/'
+  source_path:     &systest_generated_path './system/generated/'
+  unit_tests_path: &unit_tests_path '../examples/test/'
+  mocks_path:      &systest_mocks_path './system/generated/'
+  build_path:      &systest_build_path './system/build/'
   options:
     - --dlib_config
     - [*tools_root, 'arm\inc\DLib_Config_Normal.h']
@@ -36,12 +36,12 @@ compiler:
       - *systest_generated_path
       - *unit_tests_path
       - *systest_mocks_path
-      - 'src/'
-      - 'vendor/unity/src/'
-      - 'vendor/c_exception/lib/'
-      - 'iar\iar_v5\incIAR\'
-      - 'test\system\test_compilation\'
-      - 'test\'
+      - '../src/'
+      - '../vendor/unity/src/'
+      - '../vendor/c_exception/lib/'
+      - './system/test_compilation/'
+      - './'
+      - '.\iar\iar_v5\incIAR\'
   defines:
     prefix: '-D'
     items:

data/vendor/cmock/test/test_helper.rb

@@ -15,14 +15,10 @@ end
 
 def create_stub(funcs)
   stub = Class.new
-  #if (RUBY_VERSION.split('.')[0].to_i >= 2)
-  #  funcs.each_pair {|k,v| stub.define_singleton_method(k) {|*unused| return v } }
-  #else
-    blob = "class << stub\n"
-    funcs.each_pair {|k,v| blob += "def #{k.to_s}(unused=nil)\n #{v.inspect}\nend\n" }
-    blob += "end"
-    eval blob
-  #end
+  blob = "class << stub\n"
+  funcs.each_pair {|k,v| blob += "def #{k.to_s}(unused=nil)\n #{v.inspect}\nend\n" }
+  blob += "end"
+  eval blob
   stub
 end
 

data/vendor/cmock/test/unit/cmock_config_test.rb

@@ -6,7 +6,7 @@
 
 
 require File.expand_path(File.dirname(__FILE__)) + "/../test_helper"
-require 'cmock_config'
+require File.expand_path(File.dirname(__FILE__)) + '/../../lib/cmock_config'
 
 
 describe CMockConfig, "Verify CMockConfig Module" do

data/vendor/cmock/test/unit/cmock_file_writer_test.rb

@@ -5,7 +5,7 @@
 # ==========================================
 
 require File.expand_path(File.dirname(__FILE__)) + "/../test_helper"
-require 'cmock_file_writer'
+require File.expand_path(File.dirname(__FILE__)) + '/../../lib/cmock_file_writer'
 
 describe CMockFileWriter, "Verify CMockFileWriter Module" do
 

data/vendor/cmock/test/unit/cmock_generator_main_test.rb

@@ -7,7 +7,7 @@
 $ThisIsOnlyATest = true
 
 require File.expand_path(File.dirname(__FILE__)) + "/../test_helper"
-require 'cmock_generator'
+require File.expand_path(File.dirname(__FILE__)) + '/../../lib/cmock_generator'
 
 class MockedPluginHelper
   def initialize return_this

data/vendor/cmock/test/unit/cmock_generator_plugin_array_test.rb

@@ -5,7 +5,7 @@
 # ==========================================
 
 require File.expand_path(File.dirname(__FILE__)) + "/../test_helper"
-require 'cmock_generator_plugin_array'
+require File.expand_path(File.dirname(__FILE__)) + '/../../lib/cmock_generator_plugin_array'
 
 describe CMockGeneratorPluginArray, "Verify CMockPGeneratorluginArray Module" do
   before do

data/vendor/cmock/test/unit/cmock_generator_plugin_callback_test.rb

@@ -5,7 +5,7 @@
 # ==========================================
 
 require File.expand_path(File.dirname(__FILE__)) + "/../test_helper"
-require 'cmock_generator_plugin_callback'
+require File.expand_path(File.dirname(__FILE__)) + '/../../lib/cmock_generator_plugin_callback'
 
 describe CMockGeneratorPluginCallback, "Verify CMockGeneratorPluginCallback Module" do
 
@@ -14,6 +14,7 @@ describe CMockGeneratorPluginCallback, "Verify CMockGeneratorPluginCallback Modu
 
     @config.expect :callback_include_count, true
     @config.expect :callback_after_arg_check, false
+    @config.expect :plugins, [:ignore]
 
     @cmock_generator_plugin_callback = CMockGeneratorPluginCallback.new(@config, @utils)
   end
@@ -240,6 +241,7 @@ describe CMockGeneratorPluginCallback, "Verify CMockGeneratorPluginCallback Modu
 
     expected = ["void Lemon_StubWithCallback(CMOCK_Lemon_CALLBACK Callback)\n",
                 "{\n",
+                "  Mock.Lemon_IgnoreBool = (int)0;\n",
                 "  Mock.Lemon_CallbackFunctionPointer = Callback;\n",
                 "}\n\n"
                ].join

data/vendor/cmock/test/unit/cmock_generator_plugin_cexception_test.rb

@@ -5,7 +5,7 @@
 # ==========================================
 
 require File.expand_path(File.dirname(__FILE__)) + "/../test_helper"
-require 'cmock_generator_plugin_cexception'
+require File.expand_path(File.dirname(__FILE__)) + '/../../lib/cmock_generator_plugin_cexception'
 
 describe CMockGeneratorPluginCexception, "Verify CMockGeneratorPluginCexception Module" do
 

data/vendor/cmock/test/unit/cmock_generator_plugin_expect_a_test.rb

@@ -5,7 +5,7 @@
 # ==========================================
 
 require File.expand_path(File.dirname(__FILE__)) + "/../test_helper"
-require 'cmock_generator_plugin_expect'
+require File.expand_path(File.dirname(__FILE__)) + '/../../lib/cmock_generator_plugin_expect'
 
 describe CMockGeneratorPluginExpect, "Verify CMockGeneratorPluginExpect Module Without Global Ordering" do
 

data/vendor/cmock/test/unit/cmock_generator_plugin_expect_any_args_test.rb

@@ -5,7 +5,7 @@
 # ==========================================
 
 require File.expand_path(File.dirname(__FILE__)) + "/../test_helper"
-require 'cmock_generator_plugin_expect_any_args.rb'
+require File.expand_path(File.dirname(__FILE__)) + '/../../lib/cmock_generator_plugin_expect_any_args.rb'
 
 describe CMockGeneratorPluginExpectAnyArgs, "Verify CMockGeneratorPluginExpectAnyArgs Module" do
 

data/vendor/cmock/test/unit/cmock_generator_plugin_expect_b_test.rb

@@ -5,7 +5,7 @@
 # ==========================================
 
 require File.expand_path(File.dirname(__FILE__)) + "/../test_helper"
-require 'cmock_generator_plugin_expect'
+require File.expand_path(File.dirname(__FILE__)) + '/../../lib/cmock_generator_plugin_expect'
 
 describe CMockGeneratorPluginExpect, "Verify CMockGeneratorPluginExpect Module with Global Ordering" do
 

data/vendor/cmock/test/unit/cmock_generator_plugin_ignore_arg_test.rb

@@ -5,7 +5,7 @@
 # ==========================================
 
 require File.expand_path(File.dirname(__FILE__)) + "/../test_helper"
-require 'cmock_generator_plugin_ignore_arg'
+require File.expand_path(File.dirname(__FILE__)) + '/../../lib/cmock_generator_plugin_ignore_arg'
 
 describe CMockGeneratorPluginIgnoreArg, "Verify CMockGeneratorPluginIgnoreArg Module" do
 

data/vendor/cmock/test/unit/cmock_generator_plugin_ignore_test.rb

@@ -5,7 +5,7 @@
 # ==========================================
 
 require File.expand_path(File.dirname(__FILE__)) + "/../test_helper"
-require 'cmock_generator_plugin_ignore'
+require File.expand_path(File.dirname(__FILE__)) + '/../../lib/cmock_generator_plugin_ignore'
 
 describe CMockGeneratorPluginIgnore, "Verify CMockGeneratorPluginIgnore Module" do
 

data/vendor/cmock/test/unit/cmock_generator_plugin_return_thru_ptr_test.rb

@@ -5,7 +5,7 @@
 # ==========================================
 
 require File.expand_path(File.dirname(__FILE__)) + "/../test_helper"
-require 'cmock_generator_plugin_return_thru_ptr'
+require File.expand_path(File.dirname(__FILE__)) + '/../../lib/cmock_generator_plugin_return_thru_ptr'
 
 describe CMockGeneratorPluginReturnThruPtr, "Verify CMockGeneratorPluginReturnThruPtr Module" do
 

data/vendor/cmock/test/unit/cmock_generator_utils_test.rb

@@ -5,7 +5,7 @@
 # ==========================================
 
 require File.expand_path(File.dirname(__FILE__)) + "/../test_helper"
-require 'cmock_generator_utils'
+require File.expand_path(File.dirname(__FILE__)) + '/../../lib/cmock_generator_utils'
 
 describe CMockGeneratorUtils, "Verify CMockGeneratorUtils Module" do
 

data/vendor/cmock/test/unit/cmock_header_parser_test.rb

@@ -5,10 +5,9 @@
 # ==========================================
 
 $ThisIsOnlyATest = true
-$QUICK_RUBY_VERSION = RUBY_VERSION.split('.').inject(0){|vv,v| vv * 100 + v.to_i }
 
 require File.expand_path(File.dirname(__FILE__)) + "/../test_helper"
-require 'cmock_header_parser'
+require File.expand_path(File.dirname(__FILE__)) + '/../../lib/cmock_header_parser'
 
 describe CMockHeaderParser, "Verify CMockHeaderParser Module" do
 
@@ -326,6 +325,18 @@ describe CMockHeaderParser, "Verify CMockHeaderParser Module" do
       "{\n" +
       "    bar((unsigned int) a);\n" +
       "    stripme(a);\n" +
+      "}\n" +
+      "uint32 func_with_decl_c(unsigned int);\n" +
+      "uint32 func_with_decl_c(unsigned int a)\n" +
+      "{\n" +
+      "    if(a > 0)\n" +
+      "    {\n" +
+      "       return 1;\n" +
+      "    }\n" +
+      "    else\n"+
+      "    {\n" +
+      "       return 2;\n" +
+      "    }\n" +
       "}\n"
 
     expected =
@@ -334,6 +345,8 @@ describe CMockHeaderParser, "Verify CMockHeaderParser Module" do
       "uint32 func_with_decl_a",                 #okay. it's not going to be interpretted as another function
       "uint32 func_with_decl_b(unsigned int)",
       "uint32 func_with_decl_b",                 #okay. it's not going to be interpretted as another function
+      "uint32 func_with_decl_c(unsigned int)",
+      "uint32 func_with_decl_c",                 #okay. it's not going to be interpretted as another function
     ]
 
     assert_equal(expected, @parser.import_source(source).map!{|s|s.strip})

data/vendor/cmock/test/unit/cmock_plugin_manager_test.rb

@@ -5,10 +5,10 @@
 # ==========================================
 
 require File.expand_path(File.dirname(__FILE__)) + "/../test_helper"
-require 'cmock_plugin_manager'
-require 'cmock_generator_plugin_expect'
-require 'cmock_generator_plugin_ignore'
-require 'cmock_generator_plugin_cexception'
+require File.expand_path(File.dirname(__FILE__)) + '/../../lib/cmock_plugin_manager'
+require File.expand_path(File.dirname(__FILE__)) + '/../../lib/cmock_generator_plugin_expect'
+require File.expand_path(File.dirname(__FILE__)) + '/../../lib/cmock_generator_plugin_ignore'
+require File.expand_path(File.dirname(__FILE__)) + '/../../lib/cmock_generator_plugin_cexception'
 
 describe CMockPluginManager, "Verify CMockPluginManager Module" do
 
@@ -21,12 +21,8 @@ describe CMockPluginManager, "Verify CMockPluginManager Module" do
       :ignore => :args_and_calls
     )
 
-    #if (RUBY_VERSION.split('.')[0].to_i >= 2)
-    #  @config.define_singleton_method( :plugins ){ @plugins || [] }
-    #  @config.define_singleton_method( :plugins= ){ |val| @plugins = val }
-    #else
-      eval "class << @config\ndef plugins\n@plugins||[]\nend\ndef plugins=(val)\n@plugins=val\nend\nend\n"
-    #end
+    eval "class << @config\ndef plugins\n@plugins||[]\nend\ndef plugins=(val)\n@plugins=val\nend\nend\n"
+
   end
 
   after do

data/vendor/cmock/test/unit/cmock_unityhelper_parser_test.rb

@@ -5,7 +5,7 @@
 # ==========================================
 
 require File.expand_path(File.dirname(__FILE__)) + "/../test_helper"
-require 'cmock_unityhelper_parser'
+require File.expand_path(File.dirname(__FILE__)) + '/../../lib/cmock_unityhelper_parser'
 
 describe CMockUnityHelperParser, "Verify CMockUnityHelperParser Module" do
 

data/vendor/cmock/vendor/c_exception/README.md

@@ -9,10 +9,16 @@ CException is simple exception handling in C. It is significantly faster than fu
 Getting Started
 ================
 
+The simplest way to get started is to just grab the code and pull it into your project:
+
 	> git clone --recursive https://github.com/throwtheswitch/cexception.git
+	
+If you want to contribute to this project, you'll also need to have Ruby installed to run the unit tests. You can automatically
+install all the things you need by doing this:
+
 	> cd cexception
 	> bundle install # Ensures you have all RubyGems needed
-	> bundle execute rake # Run CException tests
+	> bundle exec rake # Run CException tests
 
 Usage
 =====
@@ -148,7 +154,7 @@ License
 =======
 
 *This software is licensed under the MIT License:
-Copyright (c) 2007-2016 Mark VanderVoord*
+Copyright (c) 2007-2017 Mark VanderVoord*
 
 *Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.*

data/vendor/cmock/vendor/c_exception/docs/{readme.txt → CException.md}

@@ -1,17 +1,19 @@
-====================================================================
+
 CException
-====================================================================
+==========
 
 CException is a basic exception framework for C, suitable for use in
 embedded applications.  It provides an exception framework similar in
 use to C++, but with much less overhead.
 
-CException uses C standard library functions setjmp and longjmp to
+
+CException uses C standard library functions `setjmp` and `longjmp` to
 operate.  As long as the target system has these two functions defined,
 this library should be useable with very little configuration.  It
 even supports environments where multiple program flows are in use,
 such as real-time operating systems.
 
+
 There are about a gabillion exception frameworks using a similar
 setjmp/longjmp method out there... and there will probably be more
 in the future. Unfortunately, when we started our last embedded
@@ -19,142 +21,149 @@ project, all those that existed either (a) did not support multiple
 tasks (therefore multiple stacks) or (b) were way more complex than
 we really wanted.  CException was born.
 
-Why use CException?
 
-0. It's ANSI C, and it beats passing error codes around.
+*Why use CException?*
+
 
+0. It's ANSI C, and it beats passing error codes around.
 1. You want something simple... CException throws a single id. You can
    define those ID's to be whatever you like. You might even choose which
    type that number is for your project. But that's as far as it goes.
    We weren't interested in passing objects or structs or strings...
    just simple error codes.
-
 2. Performance... CException can be configured for single tasking or
    multitasking. In single tasking, there is very little overhead past
    the setjmp/longjmp calls (which are already fast). In multitasking,
    your only additional overhead is the time it takes you to determine
    a unique task id 0 - num_tasks.
 
-For the latest version, go to http://cexception.sourceforge.net
 
---------------------------------------------------------------------
+For the latest version, go to [ThrowTheSwitch.org](http://throwtheswitch.org)
+
+
 CONTENTS OF THIS DOCUMENT
---------------------------------------------------------------------
+=========================
+
+* Usage
+* Limitations
+*API
+* Configuration
+* Testing
+* License
 
-Usage
-Limitations
-API
-Configuration
-Testing
-License
 
---------------------------------------------------------------------
 Usage
---------------------------------------------------------------------
+-----
 
-Code that is to be protected are wrapped in Try { } Catch { } blocks.
+Code that is to be protected are wrapped in `Try { } Catch { }` blocks.
 The code directly following the Try call is "protected", meaning that
 if any Throws occur, program control is directly transferred to the
 start of the Catch block.
 
+
 A numerical exception ID is included with Throw, and is made accessible
 from the Catch block.
 
+
 Throws can occur from within function calls (nested as deeply as you
 like) or directly from within the function itself.
 
---------------------------------------------------------------------
+
+
 Limitations
---------------------------------------------------------------------
+-----------
+
 
 This library was made to be as fast as possible, and provide basic
 exception handling.  It is not a full-blown exception library.  Because
 of this, there are a few limitations that should be observed in order
 to successfully utilize this library:
 
-1. Do not directly "return" from within a Try block, nor "goto"
-   into or out of a Try block.
+1. Do not directly "return" from within a `Try` block, nor `goto`
+   into or out of a `Try` block.
 
-   Why?
+   *Why?*
 
-   The "Try" macro allocates some local memory and alters a global
-   pointer.  These are cleaned up at the top of the "Catch" macro.
+   The `Try` macro allocates some local memory and alters a global
+   pointer.  These are cleaned up at the top of the `Catch` macro.
    Gotos and returns would bypass some of these steps, resulting in
    memory leaks or unpredictable behavior.
 
-2. If (a) you change local (stack) variables within your Try block,
+
+2. If (a) you change local (stack) variables within your `Try` block,
    AND (b) wish to make use of the updated values after an exception
-   is thrown, those variables should be made volatile. Note that this
+   is thrown, those variables should be made `volatile`. Note that this
    is ONLY for locals and ONLY when you need access to them after a
-   throw.
+   `Throw`.
 
-   Why?
+   *Why?*
 
    Compilers optimize.  There is no way to guarantee that the actual
    memory location was updated and not just a register unless the
    variable is marked volatile.
 
-3. Memory which is malloc'd or new'd is not automatically released
+
+3. Memory which is `malloc`'d or `new`'d is not automatically released
    when an error is thrown.  This will sometimes be desirable, and
-   othertimes may not.  It will be the responsibility of the Catch
+   othertimes may not.  It will be the responsibility of the `Catch`
    block to perform this kind of cleanup.
 
-   Why?
+   *Why?*
 
-   There's just no easy way to track malloc'd memory, etc., without
+   There's just no easy way to track `malloc`'d memory, etc., without
    replacing or wrapping malloc calls or something like that.  This
    is a light framework, so these options were not desirable.
 
---------------------------------------------------------------------
-API
---------------------------------------------------------------------
 
-Try
+
+API
 ---
 
-Try is a macro which starts a protected block.  It MUST be followed by
+###Try
+
+`Try` is a macro which starts a protected block.  It MUST be followed by
 a pair of braces or a single protected line (similar to an 'if'),
-enclosing the data that is to be protected.  It MUST be followed by a
-Catch block (don't worry, you'll get compiler errors to let you know if
+enclosing the data that is to be protected.  It **must** be followed by a
+`Catch` block (don't worry, you'll get compiler errors to let you know if
 you mess any of that up).
 
-Catch(e)
---------
 
-Catch is a macro which ends the Try block and starts the error handling
-block. The catch block is called if and only if an exception was thrown
-while within the Try block.  This error was thrown by a Throw call
-somewhere within Try (or within a function called within Try, or a function
-called by a function called within Try, etc).
+###Catch(e)
+
+`Catch` is a macro which ends the `Try` block and starts the error handling
+block. The `Catch` block is called if and only if an exception was thrown
+while within the `Try` block.  This error was thrown by a `Throw` call
+somewhere within `Try` (or within a function called within `Try`, or a function
+called by a function called within `Try`, etc).
 
-The single parameter 'e' is filled with the error code which was thrown.
+The single parameter `e` is filled with the error code which was thrown.
 This can be used for reporting, conditional cleanup, etc. (or you can just
 ignore it if you really want... people ignore return codes all the time,
-right?).  'e' should be of type EXCEPTION_T;
+right?).  `e` should be of type `EXCEPTION_T`
 
-Throw(e)
---------
 
-The method of throwing an error.  Throws should only occur from within a
-protected (Try...Catch) block, though it may easily be nested many function
-calls deep without an impact on performance or functionality.  Throw takes
-a single argument, which is an exception id which will be passed to Catch
+###Throw(e)
+
+This is the method of throwing an error. A `Throw` should only occur from within a
+protected (`Try` ... `Catch`) block, though it may easily be nested many function
+calls deep without an impact on performance or functionality. `Throw` takes
+a single argument, which is an exception id which will be passed to `Catch`
 as the reason for the error.
 
-If you wish to Rethrow an error, this can be done by calling Throw(e) with
-the error code you just caught.  It IS valid to throw from a catch block.
+If you wish to rethrow an error, this can be done by calling `Throw(e)` with
+the error code you just caught.  It **is** valid to throw from a catch block.
+
 
-ExitTry()
----------
+###ExitTry()
 
-On rare occasion, you might want to immediately exit your current Try block
-but NOT treat this as an error. Don't run the Catch. Just start executing
-from after the Catch as if nothing had happened... That's what ExitTry is
+On rare occasion, you might want to immediately exit your current `Try` block
+but **not** treat this as an error. Don't run the `Catch`. Just start executing
+from after the `Catch` as if nothing had happened... That's what `ExitTry` is
 for.
 
---------------------------------------------------------------------
+
 CONFIGURATION
---------------------------------------------------------------------
+-------------
 
 CException is a mostly portable library.  It has one universal
 dependency, and some macros which are required if working in a
@@ -172,75 +181,97 @@ multi-tasking environment.
    for each protected block and once during a throw.  This is the
    only overhead in the system.
 
+
 Exception.h
------------------
-By convention, most projects include Exception.h which defines any
-further requirements, then calls CException.h to do the gruntwork.  All
-of these are optional.  You could directly include CException.h if
+-----------
+
+By convention, most projects include `Exception.h` which defines any
+further requirements, then calls `CException.h` to do the gruntwork.  All
+of these are optional.  You could directly include `CException.h` if
 you wanted and just use the defaults provided.
 
-EXCEPTION_T      - Set this to the type you want your exception id's
-                   to be.  Defaults to 'unsigned int'.
+* `EXCEPTION_T`
+  * Set this to the type you want your exception id's to be.  Defaults to 'unsigned int'.
+
+* `EXCEPTION_NONE`
+  * Set this to a number which will never be an exception id in your system.  Defaults to `0x5a5a5a5a`.
 
-EXCEPTION_NONE   - Set this to a number which will never be an
-                   exception id in your system.  Defaults to 0x5a5a5a5a.
+* `EXCEPTION_GET_ID`
+  * If in a multi-tasking environment, this should be
+    set to be a call to the function described in #2 above.
+    Defaults to just return `0` all the time (good for
+    single tasking environments)
 
-EXCEPTION_GET_ID - If in a multi-tasking environment, this should be
-                   set to be a call to the function described in #2 above.
-                   Defaults to just return 0 all the time (good for
-                   single tasking environments)
+* `EXCEPTION_NUM_ID`
+  * If in a multi-tasking environment, this should be set
+    to the number of ID's required (usually the number of
+    tasks in the system).  Defaults to `1` (for single
+    tasking environments).
 
-EXCEPTION_NUM_ID - If in a multi-tasking environment, this should be set
-                   to the number of ID's required (usually the number of
-                   tasks in the system).  Defaults to 1 (for single
-                   tasking environments).
+* `CEXCEPTION_NO_CATCH_HANDLER(id)`
+  * This macro can be optionally specified.
+    It allows you to specify code to be called when a Throw
+    is made outside of `Try` ... `Catch` protection.  Consider
+    this the emergency fallback plan for when something has
+    gone terribly wrong.
 
-CEXCEPTION_NO_CATCH_HANDLER(id) - This macro can be optionally specified.
-                   It allows you to specify code to be called when a Throw
-                   is made outside of Try...Catch protection.  Consider
-                   this the emergency fallback plan for when something has
-                   gone terribly wrong.
 
 You may also want to include any header files which will commonly be
 needed by the rest of your application where it uses exception handling
 here.  For example, OS header files or exception codes would be useful.
 
+
 Finally, there are some hook macros which you can implement to inject
 your own target-specific code in particular places. It is a rare instance
 where you will need these, but they are here if you need them:
 
-CEXCEPTION_HOOK_START_TRY - called immediately before the Try block
-CEXCEPTION_HOOK_HAPPY_TRY - called immediately after the Try block
-                            if no exception was thrown
-CEXCEPTION_HOOK_AFTER_TRY - called immediately after the Try block
-                            OR before an exception is caught
-CEXCEPTION_HOOK_START_CATCH - called immediately before the catch
 
---------------------------------------------------------------------
+* `CEXCEPTION_HOOK_START_TRY`
+  * called immediately before the Try block
+
+* `CEXCEPTION_HOOK_HAPPY_TRY`
+  * called immediately after the Try block if no exception was thrown
+
+* `CEXCEPTION_HOOK_AFTER_TRY`
+  * called immediately after the Try block OR before an exception is caught
+
+* `CEXCEPTION_HOOK_START_CATCH`
+  * called immediately before the catch
+
+
+
 TESTING
---------------------------------------------------------------------
+-------
+
 
 If you want to validate that CException works with your tools or that
 it works with your custom configuration, you may want to run the test
 suite.
 
-The test suite included makes use of the Unity Test Framework.  It will
+
+The test suite included makes use of the `Unity` Test Framework.  It will
 require a native C compiler. The example makefile uses MinGW's gcc.
-Modify the makefile to include the proper paths to tools, then run 'make'
+Modify the makefile to include the proper paths to tools, then run `make`
 to compile and run the test application.
 
-C_COMPILER - The C compiler to use to perform the tests
-C_LIBS - The path to the C libraries (including setjmp)
-UNITY_DIR - The path to the Unity framework (required to run tests)
-            (get it at http://unity.sourceforge.net)
+* `C_COMPILER`
+  * The C compiler to use to perform the tests
+
+* `C_LIBS`
+  * The path to the C libraries (including setjmp)
+
+* `UNITY_DIR`
+  * The path to the Unity framework (required to run tests)
+    (get it at [ThrowTheSwitch.org](http://throwtheswitch.org))
+
+
 
---------------------------------------------------------------------
 LICENSE
---------------------------------------------------------------------
+-------
 
 This software is licensed under the MIT License
 
-Copyright (c) 2007-2016 Mark VanderVoord
+Copyright (c) 2007-2017 Mark VanderVoord
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal