D17466: Fix doxygen markdown rendering
This revision was automatically updated to reflect the committed changes. Closed by commit R264:28dca00d2f3a: Fix doxygen markdown rendering (authored by argonel). REPOSITORY R264 KApiDox CHANGES SINCE LAST UPDATE https://phabricator.kde.org/D17466?vs=47230=47589 REVISION DETAIL https://phabricator.kde.org/D17466 AFFECTED FILES docs/metainfo_syntax.md To: argonel, apol Cc: apol, kde-frameworks-devel, kde-doc-english, michaelh, ngraham, bruns, skadinna
D17466: Fix doxygen markdown rendering
apol accepted this revision. apol added a comment. This revision is now accepted and ready to land. As discussed or IRC REPOSITORY R264 KApiDox BRANCH fix_yaml_rendering REVISION DETAIL https://phabricator.kde.org/D17466 To: argonel, apol Cc: apol, kde-frameworks-devel, kde-doc-english, michaelh, ngraham, bruns, skadinna
D17466: Fix doxygen markdown rendering
apol added a comment.
~~~{.yaml}
hallo
~~~
But then it doesn't work here. Is it maybe possible to force the usage of
github markdown on it?
REPOSITORY
R264 KApiDox
REVISION DETAIL
https://phabricator.kde.org/D17466
To: argonel
Cc: apol, kde-frameworks-devel, kde-doc-english, michaelh, ngraham, bruns,
skadinna
D17466: Fix doxygen markdown rendering
argonel added a comment. The use of tildes for doxygen code blocks is documented here: https://www.stack.nl/~dimitri/doxygen/manual/markdown.html#md_fenced REPOSITORY R264 KApiDox REVISION DETAIL https://phabricator.kde.org/D17466 To: argonel Cc: apol, kde-frameworks-devel, kde-doc-english, michaelh, ngraham, bruns, skadinna
D17466: Fix doxygen markdown rendering
apol added a comment. 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. REPOSITORY R264 KApiDox REVISION DETAIL https://phabricator.kde.org/D17466 To: argonel Cc: apol, kde-frameworks-devel, kde-doc-english, michaelh, ngraham, bruns, skadinna
D17466: Fix doxygen markdown rendering
argonel created this revision. Herald added projects: Frameworks, Documentation. Herald added subscribers: kde-doc-english, kde-frameworks-devel. argonel requested review of this revision. REVISION 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 REPOSITORY R264 KApiDox BRANCH fix_yaml_rendering REVISION DETAIL https://phabricator.kde.org/D17466 AFFECTED FILES docs/metainfo_syntax.md To: argonel Cc: kde-frameworks-devel, kde-doc-english, michaelh, ngraham, bruns, skadinna
