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

Gunar Schorcht notifications at github.com
Mon Jan 14 14:42:33 CET 2019


Using additionally ```FULL_PATH_NAMES = YES``` in `riot.doxyfile` seems to solve the referencing problem. In group `drivers_sx127x`, the `drivers/sx127x/include/sx127x_params.h` file is used while group `boards_nz32-sc151` uses the board specific file `boards/nz32-sc151/include/sx127x_params.h`.

As a side effect, relative file paths are not shown any longer in the documentation. Since these paths look to me more random than deterministic, not showing such relative file paths might be rather an advantage than a disadvantage. For example, take a look to the `Modules / CPU /ESP32` entry in the navigation tree.
```
adc_arch.h
esp32/include/cpu.h
esp32/include/cpu_conf.h
esp_common.h
esp_common_log.h
esp32/include/exceptions.h
gpio_arch.h
esp32/include/irq_arch.h
cpu/esp32/include/log_module.h
esp32/include/periph_cpu.h
sdk_conf.h
cpu/esp32/include/sys/types.h
esp32/include/syscalls.h
esp32/include/thread_arch.h
esp32/include/tools.h
esp32/include/xtensa_conf.h
```
Although these files reside all in the same directory, the relative paths given here are different.

>From my point of view it would be more important to get parameters documented than to have relative paths in documentation.

-- 
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-454008417
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.riot-os.org/pipermail/notifications/attachments/20190114/f599559d/attachment.html>


More information about the notifications mailing list