[riot-notifications] [RIOT-OS/RIOT] doc/driver-guide.md : Update documentation (#14050)

Leandro Lanzieri notifications at github.com
Mon May 11 14:37:57 CEST 2020


@leandrolanzieri requested changes on this pull request.



> -
-#ifndef TMPABC_PARAMS
-#define TMPABC_PARAMS           { .i2c  = TMPABC_PARAM_I2C \
-                                  .addr = TMPABC_PARAM_ADDR }
-#endif
-/** @} */
-
-/**
- * @brief   Allocation of TMPABC configuration
- */
-static const tmpabc_params_t tmpabc_params[] = {
-    TMPABC_PARAMS
-}
-/* ... */
- at endcode
+    #include "board.h"  /* THIS INCLUDE IS MANDATORY */

Why removing the `@code{.c}` directives? To me it fails to properly compile the documentation.

>  
 And finally, we can simply override the `tmpabc_params.h` file as described
 above.
 
+## Doxygen Documentation                                 {#driver-guide-doxygen}
+
+The above mentioned configurations can be made to show up in the listing for
+[Compile time configurations](@ref config). Refer to the following example that
+exposes TMPABC sensor to [sensors group](@ref config_drivers_sensors).
+
+    /**
+    * @brief   Default configuration parameters for TMPABC sensors

I don't think it's necessary to copy again all the code here just to indicate that the macros can be grouped and added to the `config_drivers_sensors` group.

Also, this does not look like the best example of driver configuration, because you are adding the 'param' macros to the groups. We want to have the macros that configure the driver itself there (e.g. [TMP006](http://doc.riot-os.org/group__drivers__tmp00x__config.html))

>  
 And finally, we can simply override the `tmpabc_params.h` file as described
 above.
 
+## Doxygen Documentation                                 {#driver-guide-doxygen}

```suggestion
## Compile-time configuration documentation                                 {#driver-guide-doxygen}
```

-- 
You are receiving this because you are subscribed to this thread.
Reply to this email directly or view it on GitHub:
https://github.com/RIOT-OS/RIOT/pull/14050#pullrequestreview-409122909
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.riot-os.org/pipermail/notifications/attachments/20200511/1010c3e0/attachment.htm>


More information about the notifications mailing list