doc: move pkg/PORTING.md and pkg/USING.md to doxygen#4289
doc: move pkg/PORTING.md and pkg/USING.md to doxygen#4289OlegHahm merged 1 commit intoRIOT-OS:masterfrom
Conversation
|
Didn't you say that doxygen can parse markdown as well? |
|
It can parse it, yes. But it generates automatically pages for every new markdown file (named the name of the markdown file). We don't want this here, but just a module documentation. In detail: when adding a I don't want this empty |
|
I see. |
|
A somewhat related configuration option I came across by accident: |
|
I saw this, too. But since PRs like #4285 will introduce further pages, I thought it to be less consistent. Additionally, the doxygen markdown still requires labels to be of any use to doxygen (Sub-sections in page tree, TOC, and ability to reference sections or pages from within doxygen). This isn't parsed however by GitHub properly (as well as the |
|
Rebased to current master |
doc/doxygen/riot.doxyfile
Outdated
There was a problem hiding this comment.
Fixed and squashed immediately
There was a problem hiding this comment.
maybe INCLUDE += $(RIOTBASE)/pkg/<pkg_name>/<path to include directory> could be even more explicit, or is that overkill?
There was a problem hiding this comment.
I think that's overkill. Also the pkg directory might be the include directory.
|
ACK and go! |
doc: move pkg/PORTING.md and pkg/USING.md to doxygen
Moves the documentation for packages to doxygen.