Fix doxygen markdown rendering
ClosedPublic

Authored by argonel on Dec 10 2018, 3:26 AM.

Details

Summary

Doxygen's parser appears to have trouble with code blocks delimited by
backticks and lines within the code blocks that end with backticks.

This also fixes an issue where a heading isn't rendered correctly
unless it has a blank line after it.

Test Plan

built docs locally

Diff Detail

Repository
R264 KApiDox
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.
argonel created this revision.Dec 10 2018, 3:26 AM
Restricted Application added projects: Frameworks, Documentation. · View Herald TranscriptDec 10 2018, 3:26 AM
Restricted Application added subscribers: kde-doc-english, kde-frameworks-devel. · View Herald Transcript
argonel requested review of this revision.Dec 10 2018, 3:26 AM
apol added a subscriber: apol.Dec 10 2018, 4:39 PM

If we are doing markdown, it could make sense why such common markdown isn't working too, otherwise this is bound to happen anyway. I've actually never seen this ~~~ thing.

The use of tildes for doxygen code blocks is documented here: https://www.stack.nl/~dimitri/doxygen/manual/markdown.html#md_fenced

apol added a comment.Dec 11 2018, 12:49 AM

~~~{.yaml}
hallo
~~~

But then it doesn't work here. Is it maybe possible to force the usage of github markdown on it?

apol accepted this revision.Dec 11 2018, 12:55 AM

As discussed or IRC

This revision is now accepted and ready to land.Dec 11 2018, 12:55 AM
This revision was automatically updated to reflect the committed changes.