On 23.09.22 08:55, Chris Johns wrote:
Do we want a single chapter with all Classic API types?

Do we want a section per manager for the types?

Which types should be documented?

I would document them in a single chapter and only structs.

There are 2 cases in relation to this thread and patch. Having something documented with the macro that is the right type and then a simple means to step from a specific function/macro to the fields if a struct. Does this make sense?

The types can be fixed by using an inline function instead of a macro. For directives which need a macro implementation, we could add an additional real function just like for rtems_build_name().


I have not consider any more so I am not sure how we handle all the types. Maybe Joel or Gedare do. 😄

The missing types documentation is also relevant to other functions, for example:

https://docs.rtems.org/branches/master/c-user/task/directives.html#rtems-task-construct

--
embedded brains GmbH
Herr Sebastian HUBER
Dornierstr. 4
82178 Puchheim
Germany
email: sebastian.hu...@embedded-brains.de
phone: +49-89-18 94 741 - 16
fax:   +49-89-18 94 741 - 08

Registergericht: Amtsgericht MĂŒnchen
Registernummer: HRB 157899
Vertretungsberechtigte GeschĂ€ftsfĂŒhrer: Peter Rasmussen, Thomas Dörfler
Unsere DatenschutzerklÀrung finden Sie hier:
https://embedded-brains.de/datenschutzerklaerung/
_______________________________________________
devel mailing list
devel@rtems.org
http://lists.rtems.org/mailman/listinfo/devel

Reply via email to