18 Commits

Author SHA1 Message Date
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
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
0213597d46 c-user: Adjust URL for struct timespec 2022-11-08 07:39:06 +01:00
Matt Joyce
a382919ba6 c-user/clock: Fix typo 2022-11-08 06:59:24 +01:00
Sebastian Huber
162925edd0 c-user: Use document internal links 2022-01-11 09:26:52 +01:00
Sebastian Huber
e77e04d2dc c-user: Clarify Clock Manager dependencies
Update #4572.
2022-01-11 09:26:52 +01:00
Sebastian Huber
786b89ac86 c-user: Clarify time formats
Update #4572.
2021-12-16 15:44:06 +01:00
Sebastian Huber
732d8bca8f c-user: Fix Clock Manager parameter descriptions
Update #4572.
2021-12-16 07:44:49 +01:00
Sebastian Huber
838b78ad5c c-user: Replace "precision" with "resolution"
Resolution is the right term for the documented property.
2021-11-23 15:21:00 +01:00
Sebastian Huber
38ec48d292 c-user: Document new clock manager directives
Add new clock manager directives to get all times provided by the
timehands.

Close #4527.
2021-11-19 08:49:46 +01:00
Sebastian Huber
081ec5d5e9 c-user: Document time of day constraints
Close #4338.
2021-09-06 12:28:05 +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
ad16b373f3 c-user: Clarify constraints 2021-04-28 09:03:49 +02:00
Sebastian Huber
a60c5b4b3e c-user: Generate clock 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-02-17 18:34:58 +01: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
86c39ef2c4 c-user: Split up clock manager
This makes it easier to automatically generate parts of the manager
documentation in the future.

Update #3993.
2020-09-02 17:53:57 +02:00