24 Commits

Author SHA1 Message Date
Sebastian Huber
6692946100 c-user: Link task entry and global construction 2023-07-25 07:36:09 +02:00
Sebastian Huber
63a5c190b0 c-user: Fix typo
Updates #4772.
2023-07-20 15:04:10 +02:00
Sebastian Huber
be789ee60e c-user: Update copyright and use glossary terms
Updates #4772.
2023-07-20 11:27:35 +02:00
Kinsey Moore
981ba2de41 c-user: Update references to rtems_task_wake_after
rtems_task_wake_after takes a parameter in terms of a count of clock
ticks and not a measure in a subunit of seconds. This updates
documentation to reflect that. This also makes obvious the caveat about
the first tick wait not being a whole tick and points the user at a
replacement for better accuracy.

Updates #4772
2023-07-06 13:55:37 -05:00
Sebastian Huber
bbb8b7aa81 Update company name
The embedded brains GmbH & Co. KG is the legal successor of embedded
brains GmbH.
2023-05-20 11:12:29 +02:00
Sebastian Huber
e33eae15a7 c-user: Generate API type documentation
Close #4901.
2023-05-09 14:06:01 +02:00
Sebastian Huber
ee8e1fe7ac c-user: Harmonize header file references 2023-02-14 16:14:47 +01:00
Joel Sherrill
aaba6e5826 c-user/*: Add trailing parentheses on methods in index which were missing it
Closes #4766.
2022-11-30 09:59:20 -06:00
Sebastian Huber
0fc5c0336d c-user: Add application config info directives
Close #4267.
Close #4269.
2022-10-04 10:26:38 +02:00
Sebastian Huber
c98307c4f1 c-user: Add types to macros 2022-10-04 08:04:56 +02:00
Sebastian Huber
f4377b4479 c-user: Document new rtems_task_delete() behaviour
Update #4679.
2022-07-28 07:43:28 +02:00
Sebastian Huber
81fd510a5c c-user: Document task life states
Update #4679.
2022-07-28 07:43:28 +02:00
Sebastian Huber
0e200f3c9e c-user: Clarify scheduler of created task 2022-03-30 09:07:31 +02:00
Sebastian Huber
61410dad2a c-user: Use RTEMS_WHO_AM_I for rtems_task_ident() 2021-11-19 08:47:00 +01:00
Sebastian Huber
5fdc744dce c-user: Clarify task priorities 2021-09-15 07:54:43 +02:00
Sebastian Huber
c70715baea c-user: Use a common phrase for pointer parameters
Mention the type of the pointer in the parameter description.  Use the
more general term "object" instead of "variable".

Update #3993.
2021-06-15 07:47:38 +02:00
Sebastian Huber
2509b62106 c-user: Document new rtems_task_delete() error
Close #4414.
2021-05-27 07:08:41 +02:00
Sebastian Huber
2588e8bf35 c-user: Constify rtems_task_wake_when()
Update #4406.
2021-05-12 21:32:12 +02:00
Sebastian Huber
fa98f8df66 c-user: Clarify rtems_task_get_priority() 2021-05-12 21:07:00 +02:00
Sebastian Huber
7ded5943e4 c-user: Document rtems_task_set_scheduler() errors 2021-05-12 21:07:00 +02:00
Sebastian Huber
2ae3364b10 c-user: Generate task manager documentation
The documentation is a consolidation of the comments in Doxygen markup
and the documentation sources in Sphinx markup.  The documentation was
transfered to interface specification items.  The documentation source
files were generated from the items by a script.

Update #3993.
2021-04-28 09:03:49 +02:00
Sebastian Huber
698580033b c-user: Move deprecated/removed directives
This makes it easier to automatically generate parts of the manager
documentation in the future.

Update #3993.
2021-02-10 16:53:38 +01:00
Sebastian Huber
4e09c0958c c-user: Add labels to the manager chapters
Update #3993.
2021-02-10 16:53:32 +01:00
Sebastian Huber
ccb384b623 c-user: Split up task manager
This makes it easier to automatically generate parts of the manager
documentation in the future.

Update #3993.
2020-09-02 17:58:03 +02:00