[riot-notifications] [RIOT-OS/RIOT] Documentation: don't include overridden typedefs (#10964)

Gunar Schorcht notifications at github.com
Sat Mar 30 03:10:19 CET 2019


The problem is what we discussed in issue #9789. Usually, each architecture which overrides the default typedef should also have documented it's typedef in its architecture specific documentation. Bugs in doxygen lead to the problem of having a lot of duplicates in enums and the problem that the documentation of default typedefs is overwritten with any architecture specific typedef documentation :worried: Maybe, this PR avoids the later one but can't solve the causing problem.

IMHO, it is better to have documented the default typedef instead of having documented an architecture specific typedef like for [gpio_mode_t](https://riot-os.org/api/group__drivers__periph__gpio.html#ga491a2cbfb4e94f2afcc0d5bdef2dc454). When you click on `gpio_mode_t` on this page, you land in documentation of `cpu/cc2538/include/periph_cpu.h`.

-- 
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/10964#issuecomment-478196833
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.riot-os.org/pipermail/notifications/attachments/20190329/c9e76496/attachment.html>


More information about the notifications mailing list