diff options
| author | Dean Camera <dean@fourwalledcubicle.com> | 2009-06-28 13:39:08 +0000 |
|---|---|---|
| committer | Dean Camera <dean@fourwalledcubicle.com> | 2009-06-28 13:39:08 +0000 |
| commit | f1076ac4d6e56bff7fb6d2126746af1108211370 (patch) | |
| tree | 9a5f31cc5ff9c648d7ce63f1d9e8afab763d2801 /LUFA/Scheduler | |
| parent | 3cbdcd36868693cfc1863231a1ec64507ce3d29f (diff) | |
| download | lufa-f1076ac4d6e56bff7fb6d2126746af1108211370.tar.gz lufa-f1076ac4d6e56bff7fb6d2126746af1108211370.tar.bz2 lufa-f1076ac4d6e56bff7fb6d2126746af1108211370.zip | |
Added const modifiers to device mode class drivers.
Added parameter directions to function parameter documentation.
Added new experimental FAST_STREAM_FUNCTIONS compile time option to speed up stream transfers at the expense of a higher FLASH consumption (needs testing to verify improved throughput).
Diffstat (limited to 'LUFA/Scheduler')
| -rw-r--r-- | LUFA/Scheduler/Scheduler.h | 14 |
1 files changed, 7 insertions, 7 deletions
diff --git a/LUFA/Scheduler/Scheduler.h b/LUFA/Scheduler/Scheduler.h index 44e6bb06c..51679eba3 100644 --- a/LUFA/Scheduler/Scheduler.h +++ b/LUFA/Scheduler/Scheduler.h @@ -196,7 +196,7 @@ /** Resets the delay counter value to the current tick count. This should be called to reset the period
* for a delay in a task which is dependant on the current tick value.
*
- * \param DelayCounter Counter which is storing the starting tick count for a given delay.
+ * \param[out] DelayCounter Counter which is storing the starting tick count for a given delay.
*/
static inline void Scheduler_ResetDelay(SchedulerDelayCounter_t* const DelayCounter)
ATTR_NON_NULL_PTR_ARG(1) ATTR_ALWAYS_INLINE;
@@ -211,8 +211,8 @@ /* Function Prototypes: */
/** Determines if the given tick delay has elapsed, based on the given .
*
- * \param Delay The delay to test for, measured in ticks
- * \param DelayCounter The counter which is storing the starting tick value for the delay
+ * \param[in] Delay The delay to test for, measured in ticks
+ * \param[in] DelayCounter The counter which is storing the starting tick value for the delay
*
* \return Boolean true if the delay has elapsed, false otherwise
*
@@ -233,16 +233,16 @@ /** Sets the task mode for a given task.
*
- * \param Task Name of the task whose status is to be changed
- * \param TaskStatus New task status for the task (TASK_RUN or TASK_STOP)
+ * \param[in] Task Name of the task whose status is to be changed
+ * \param[in] TaskStatus New task status for the task (TASK_RUN or TASK_STOP)
*/
void Scheduler_SetTaskMode(const TaskPtr_t Task, const bool TaskStatus);
/** Sets the task mode for a given task group ID, allowing for an entire group of tasks to have their
* statuses changed at once.
*
- * \param GroupID Value of the task group ID whose status is to be changed
- * \param TaskStatus New task status for tasks in the specified group (TASK_RUN or TASK_STOP)
+ * \param[in] GroupID Value of the task group ID whose status is to be changed
+ * \param[in] TaskStatus New task status for tasks in the specified group (TASK_RUN or TASK_STOP)
*/
void Scheduler_SetGroupTaskMode(const uint8_t GroupID, const bool TaskStatus);
|