|
From: | Ankit Dhankhar |
Subject: | Re: [ft-devel] Markdown Documentation in header files |
Date: | Wed, 2 May 2018 05:12:25 +0530 |
(1)There are two formats for markup tags:<Section> and @SectionI suggest replacing these with a single format that is easy to write.
(2)I have previously discussed (with Werner) about whether to retain the current markup tags.I believe these should be selectively retained, because this (a) makes it easy to differentiatebetween sections, and (b) this may prove useful in the future if there is an additional requirement.(3)For each section of a comment block, currently there is only a starting tag, like <Section>.I suggest adding an ending tag like </Section> so that anything between these tags can bedirectly parsed as markdown.
(4)Code blocks in comments are currently wrapped in curly brackets. This can be either replacedwith the triple backticks (```) in the documentation itself, or this replacement can be handled bythe modified docmaker depending on the requirement of the to-html converter.
[Prev in Thread] | Current Thread | [Next in Thread] |