aboutsummaryrefslogtreecommitdiffstats
path: root/docs/codingstyle.html
Commit message (Collapse)AuthorAgeFilesLines
* docs: fixup code-tag positioningErik Faye-Lund2019-06-061-1/+1
| | | | | | | | | | This reads better if we include the asterisk in the code-block, as it's part of the function-reference, even though it's not technically speaking code. But as the <code>-tag isn't purely for code, this should be fine. Signed-off-by: Erik Faye-Lund <[email protected]> Reviewed-by: Eric Engestrom <[email protected]>
* docs: update doxygen-linksErik Faye-Lund2019-06-051-1/+1
| | | | | | | | | One of these URLs are dead these days, and the other one forwards to the current one, doxygen.nl. Let's get these links up to date. Signed-off-by: Erik Faye-Lund <[email protected]> Reviewed-by: Emil Velikov <[email protected]> Reviewed-by: Eric Engestrom <[email protected]>
* docs: add more more code-tagsErik Faye-Lund2019-06-051-6/+8
| | | | | | | | | | It's easier to read function-names, file-names and other "machine"-related strings if they are formatted in a monospace font. So let's mark these up with code-tags. Signed-off-by: Erik Faye-Lund <[email protected]> Reviewed-by: Emil Velikov <[email protected]> Reviewed-by: Eric Engestrom <[email protected]>
* docs: use code instead of tt-tagErik Faye-Lund2019-06-051-7/+7
| | | | | | | | | | The tt-tag has been removed from HTML5, so let's normalize this to code-tags intead. This just makes things a bit more consistent, as we've mixed these left and right so far anyway. Signed-off-by: Erik Faye-Lund <[email protected]> Reviewed-by: Emil Velikov <[email protected]> Reviewed-by: Eric Engestrom <[email protected]>
* docs: use paragraph instead of double newlinesErik Faye-Lund2019-06-051-3/+3
| | | | | | | | | This is a bit more semantically clean in HTML, and makes us keep content and presentation a bit more separated. Signed-off-by: Erik Faye-Lund <[email protected]> Reviewed-by: Emil Velikov <[email protected]> Reviewed-by: Eric Engestrom <[email protected]>
* docs: drop h1 in headerErik Faye-Lund2019-05-081-1/+1
| | | | | | | | | | | It's generally frowned upon to have more than one H1 per document in HTML4. So let's put the text directly inside the header. This means we can drop the flex-based centering, which makes things a bit easier. We also need to change the padding to rem instead of em, because the em has now changed. Signed-off-by: Erik Faye-Lund <[email protected]> Reviewed-by: Eric Engestrom <[email protected]>
* docs: remove stray paragraph-closeErik Faye-Lund2019-05-021-1/+0
| | | | | | | This isn't matching any paragraph-open tags, so let's get rid of it. Signed-off-by: Erik Faye-Lund <[email protected]> Reviewed-by: Eric Engestrom <[email protected]>
* docs: fix `<` & `>` used in html codeEric Engestrom2018-05-231-2/+2
| | | | | Signed-off-by: Eric Engestrom <[email protected]> Reviewed-by: Ian Romanick <[email protected]>
* docs: fix a few typosEric Engestrom2017-02-271-1/+1
| | | | | | | Noticed a couple, found the rest using vimspell. Signed-off-by: Eric Engestrom <[email protected]> Reviewed-by: Emil Velikov <[email protected]>
* docs: https all the links \o/Eric Engestrom2017-02-091-1/+1
| | | | | | | | | Most of them already redirected to https anyway, so we might as well avoid the redirection and the security implications by linking directly to the right protocol. Signed-off-by: Eric Engestrom <[email protected]> Reviewed-by: Brian Paul <[email protected]>
* docs: split Codying style into separate documentEmil Velikov2016-11-211-0/+142
Signed-off-by: Emil Velikov <[email protected]> Reviewed-by: Brian Paul <[email protected]>