examples prepared for release

Author: davetcc

README.md

@@ -110,7 +110,7 @@ Arduino Only - If you want to use the legacy interrupt marshalling support inste
 
 You can ask questions either in the discussions section of this repo, or using the Arduino forum. We generally answer most questions, but the rules of engagement are: **this is my hobby, I make it available because it helps others**. Don't expect immediate answers, make sure you've recreated the problem in a simple sketch that you can send to me. Please consider making at least a one time donation using the sponsor link if we do help you out.
 
-* Discussions section of this git repo (available from top menu of github page).
+* [discussions section of the Task Manager repo](https://github.com/davetcc/TaskManagerIO/discussions)
 * [Arduino discussion forum](https://forum.arduino.cc/) where questions can be asked, please tag me using `@davetcc`.
 * [Legacy discussion forum probably to be made read only soon](https://www.thecoderscorner.com/jforum/).
 

src/ExecWithParameter.h

@@ -8,8 +8,7 @@
 
 /**
  * @file ExecWithParameter.h
- *
- * Provides convenience helper classes that allow for function callbacks with parameters
+ * @brief Provides convenience helper classes that allow for function callbacks with parameters
  */
 
 #include "TaskTypes.h"

src/MockTaskManager.h

@@ -8,8 +8,7 @@
 
 /**
  * @file MockTaskManager.h
- * 
- * This file contains a version of task manager that is useful for dev & testing.
+ * @brief This file contains a version of task manager that is useful for dev & testing.
  * None of the implementations in this file are designed for production use.
  */
 

src/TaskBlock.h

@@ -11,8 +11,7 @@
 
 /**
  * @file TaskBlock.h
- *
- * An internal class definition that is the representation of a task
+ * @brief An internal class definition that is the representation of a task
  */
 
 /**

src/TaskManagerIO.h

@@ -17,16 +17,9 @@ enum InterruptMode;
 /**
  * @file TaskManagerIO.h
  *
- * Task manager is a simple co-routine style implementation for Arduino which supports scheduling work to be done
+ * @brief Task manager is a simple co-routine style implementation for Arduino which supports scheduling work to be done
  * at a given time, repeating tasks, interrupt marshalling and events. It is generally thread safe such that code
  * outside of task manager can add, remove and manage tasks even while task manager is running.
- *
- * Note that you should never add tasks from a raw ISR, instead use task manager's marshalling of interrupts or
- * use an event that triggers on the interrupt occurring.
- *
- * The API for this class is compatible across Arduino, ESP and mbed. It is mainly thread safe on tested platforms.
- *
- * Both Commercial and Community support for task manager are available from http://www.thecoderscorner.com
  */
 
 #ifdef IOA_USE_MBED

src/TaskPlatformDeps.h

@@ -7,6 +7,11 @@
 #ifndef TASKMANAGERIO_PLATFORMDETERMINATION_H
 #define TASKMANAGERIO_PLATFORMDETERMINATION_H
 
+/**
+ * @file TaskPlatformDeps.h
+ * @brief provides the platform specific configuration for task manager
+ */
+
 class TimerTask;
 
 // You can add your own local definitions header file here, this enables you to adjust build flags in environments

src/TaskTypes.h

@@ -8,8 +8,7 @@
 
 /**
  * @file TaskTypes.h
- *
- * This class represents the core tasks that are added to task manager, and the TimerTask object itself.
+ * @brief This class represents the core tasks that are added to task manager, and the TimerTask object itself.
  */
 
 #include "TaskPlatformDeps.h"

src/TmLongSchedule.h

@@ -6,6 +6,11 @@
 #ifndef TASKMANGER_IO_TMLONGSCHEDULE_H
 #define TASKMANGER_IO_TMLONGSCHEDULE_H
 
+/**
+ * @file TmLongSchedule.h
+ * @brief long schedule support for task manager
+ */
+
 #include <TaskManagerIO.h>
 
 /**