This adds a `riotbuild-prefix.h` that is added to the `riotbuild.h`
and processed by Doxygen. It solves two problems:
1. The pre-defined macros where previously fully undocumented, but
may be useful to real world applications
2. It provides a place where backward compatibility aliases can be
added with a deprecation notice
In https://github.com/RIOT-OS/RIOT/pull/20511/files a quick fix was
added to allow resizing the sidenav. But this broke hiding the sidenav
on mobile screen widths. This fixes the issue and also increase the
default sidenav width a tad.
Currently it is not possible to resize the side-nav of the RIOT doxygen website in firefox.
This is caused by the window resize_handler being called even for resizing inside the window.
The resize_handler resets the side-nav to a cached size preventing resizing. This commit fixes
this by checking if the window was actually resized.
This fixes a regression from https://github.com/RIOT-OS/RIOT/pull/20443
which does cause the modules to re-appear in the side panel, but under
the name "Topics" rather than "Modules".
This contains minor changes to ease maintaining the document (e.g.
by using reference-style links so that an URL needs to be updated
only in a single place) and adds explicit anchors to ease linking to
a certain section.
Beginning with doxygen 1.9.8 "Modules" are renamed to "Topics". This
patch adds the new entry to the layout file. Having both, "Modules" and
"Topics" in the layout file should generate similar output for older and
newer doxygen versions.
This adds a step-by-step guide to install a dev setup based on
WSL2 / Ubuntu and native VS Code with the WSL extension. The guide
uses screenshots and adds annotations on top using Inkscape, so that
every click is documented.
The Inkscape sources are also added to allow adjusting / fixing the
annotations later on without having to record a new set of screenshots.
Co-authored-by: Dylan Laduranty <dylan.laduranty@mesotic.com>
