Conversation
sys/net/gnrc/doc.txt
Outdated
There was a problem hiding this comment.
Use markdown where you can instead of doxygen tags
|
addressed @authmillenon's comment |
sys/net/gnrc/doc.txt
Outdated
There was a problem hiding this comment.
s/ udp / UDP and why is RPL the only thing that is not abbreviated here?
There was a problem hiding this comment.
I am biased (: good hint - will update (most likely later in the morning)
|
addressed comments of @OlegHahm |
|
Since this isn't really an addition, but an enhancement, can you update the PR title and commit message please? |
sys/net/gnrc/doc.txt
Outdated
There was a problem hiding this comment.
Nitpicky, but I prefer the
Section
=======
Subsection
----------syntax over the
# Section
## Subsectionsyntax. I always think those are comments ^^
|
Slightly unrelated but can you |
sys/net/gnrc/doc.txt
Outdated
There was a problem hiding this comment.
@ref net_gnrc "GNRC" otherwise it looks weird in the compiled version
76a18e7 to
eaacf1a
Compare
sys/net/gnrc/doc.txt
Outdated
There was a problem hiding this comment.
Might be beneficial to use the @ref <module> "text" syntax here too, to get rid of all the parenthesis
eaacf1a to
12372e1
Compare
|
@authmillenon should I squash? |
|
Please consider cgundogan#8 before squashing. |
|
@authmillenon I merged your commit but it breaks the doc. Do you know how to fix this? |
|
It seems to be a parsing issue with 1.8.10. Let's hope the 1.8.9.1 on the doc server does not has this issue (since with 1.8.6 it worked fine) |
1a9c6fe to
f3559c8
Compare
|
squashed |
|
ACK and go, when travis is happy. |
doc/doxygen/src/riot-gnrc.svg
Outdated
There was a problem hiding this comment.
Whitespace error in 512 and indentation error
|
Regarding #4415 (comment): reported it to doxygen https://bugzilla.gnome.org/show_bug.cgi?id=759177 |
f3559c8 to
c21fbe9
Compare
|
@authmillenon: addressed your comments and squashed |
|
Then gogogo. ;-) |
|
Cool! Thanks for the effort! |
|
Hm, maybe it's stupid, but I think this should be added to the release branch, too. |
|
Doxygen 1.8.9.1 does not have a problem with the fenced code either :) |
This PR includes a preliminary version of gnrc's documentation. However, much more info can be added to that. @authmillenon can you add more info where you think it's necessary?