[riot-notifications] [RIOT-OS/RIOT] doxygen: *_params.h files are excluded (#10427)

Gunar Schorcht notifications at github.com
Thu Jan 17 09:21:54 CET 2019


@jcarrano @jia200x 
Doxygen seems to be buggy. But we can't expect that there will be a solution in the short term, if there will be any solution at all.

How do we continue? Should we leave it as it is and let the `* _params.h 'files completely undocumented, which is a big disadvantage in my view? Or should we workaround the bug as below without having the file pathes in the documentation. The files paths seem to be arbitrary anyway, they are always relative to the parsed file formed and thus strongly determined by the include order.

As I said, I could resolve all warnings by 
- setting `FULL_PATH_NAMES = YES`
- setting `STRIP_FROM_PATH = ../../`
- adding the file path relative to `$(RIOTBASE)` to the `@file` statement to the `*_params.h` files that exist multiple times
- removing `@file` statement from `drivers/sdcard_spi/include/sdcard_spi_params.h`

With these changes all `*_params.h` files are documented.

-- 
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/issues/10427#issuecomment-455082636
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.riot-os.org/pipermail/notifications/attachments/20190117/210d5c6a/attachment.html>


More information about the notifications mailing list