[PATCH] c-user: Add application config info directives

Sebastian Huber sebastian.huber at embedded-brains.de
Thu Sep 22 08:18:17 UTC 2022


On 17/09/2022 09:31, Chris Johns wrote:
>> +.. index:: rtems_configuration_get_rtems_api_configuration()
>> +
>> +.. _InterfaceRtemsConfigurationGetRtemsApiConfiguration:
>> +
>> +rtems_configuration_get_rtems_api_configuration()
>> +-------------------------------------------------
>> +
>> +Gets the Classic API Configuration Table of this application.
> Would a comment here that the header file xxx.h describes the fields in the
> returned structure?

The API data structures are fully specified and documented. What is 
missing is the Sphinx documentation generation support. One option would 
be to add a "Types" section to the manager chapters and document the 
corresponding types in this section.

-- 
embedded brains GmbH
Herr Sebastian HUBER
Dornierstr. 4
82178 Puchheim
Germany
email: sebastian.huber at 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/


More information about the devel mailing list