Commit graph

8 commits

Author SHA1 Message Date
Benjamin Cabé b5a50e9ae1 doc: Revert "doc: Add more known-warnings"
This reverts commit 3127d7b54c which
was forgotten when switching back to breathe from docleaf and  causing
unecessary "here's a warning about something that's not actually
a warning" :)

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2023-09-15 15:05:23 +02:00
Michael Jones e4ca936551 doc: Remove sphinx warning bt_ots_init pattern
The bt_ots_init struct has been renamed to bt_ots_init_param in commit:

  cf0ff30b53

That was previously triggering a warning in Sphinx, due to the same
name being used for a struct and function, and this pattern
was designed to silence it. We don't need the pattern any more as the
warning is gone.

Signed-off-by: Michael Jones <m.pricejones@gmail.com>
2023-07-12 11:48:42 +02:00
Michael Jones 34e50037f0 doc: Log unused log filter patterns
This allows us to identify any patterns that we can remove or that
we didn't realise are no longer in use. This might happen if issues
within doxygen or docleaf are resolved.

This allows us to remove the pattern:

  .*Duplicate C declaration.*\n.*'\.\. c:.*:: uint16_t id'.*

which does not match anything in the current set up.

We also split the filter patterns in known-warnings out into different
sections depending on their cause.

Also extend the pattern parser to ignore empty lines so that we can
have some formatting in the known-warnings file.

Signed-off-by: Michael Jones <m.pricejones@gmail.com>
2023-07-03 10:05:52 +00:00
Michael Jones 3127d7b54c doc: Add more known-warnings
We should probably clear out the old warnings and see what still
applies for docleaf now that we have that instead of breathe.

However for this moment, these are new duplication declarations that
we're seeing errors for and so we'd like to silence them.

Signed-off-by: Michael Jones <m.pricejones@gmail.com>
2023-07-03 10:05:52 +00:00
Carles Cufi 35a00551a8 doc: Bluetooth: Document the services APIs
The Bluetooth documentation was missing all the Doxygen API information
regarding the standard services implemented in the Host. Import the
Doxygen API doc in a single page.

Fixes #42520.

Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
2022-05-24 17:49:17 +02:00
Martin Jäger 2554f04464 doc: services: storage: add flash_img API
Doxygen comments were existing, but they were not rendered anywhere in
the docs. The code is located under DFU, but I think it makes sense
to document it under storage, next to similar flash-related APIs.

Signed-off-by: Martin Jäger <martin@libre.solar>
2022-05-15 21:33:54 +02:00
Gerard Marull-Paretas 775174621d doc: warnings: make expressions more generic
When duplicates exist the problem may come from two or more distinct
constructs. When running parallel builds there is no guarantee on which
one will come first (or if all), so allow any C construct.

Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
2021-05-19 06:21:53 -04:00
Gerard Marull-Paretas 96c7d10a15 doc: use warnings_filter
Replace current filter setup with the warnings_filter Sphinx extension.
Note that current regexes have been simplified to make them more
readable while keeping the most relevant information.

Sphinx warnings are now treated as errors (-W).

Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
2021-04-07 14:15:29 +02:00