mono-docs: Nicer formatting for notes
authorXavi Artigas <xavierartigas@yahoo.es>
Thu, 12 Dec 2019 15:25:43 +0000 (16:25 +0100)
committerJongmin Lee <jm105.lee@samsung.com>
Thu, 12 Dec 2019 20:52:07 +0000 (05:52 +0900)
This has never been tested because so far EO "Note:" tags are only recognized
when they appear at the beginning of a comment block.
It turns out the note already includes the "Note:" prefix so we were adding it
twice.
This patch removes one of the prefixes and used a nicer formatting.

Also works for "Warning:", "Remark:" and "TODO:".

src/bin/eolian_mono/eolian/mono/documentation.hh

index 7d90e78..2370829 100644 (file)
@@ -273,16 +273,16 @@ struct documentation_generator
                   new_text += token_text;
                 break;
               case ::EOLIAN_DOC_TOKEN_MARK_NOTE:
-                new_text += "NOTE: " + token_text;
+                new_text += "<b>NOTE:</b>" + token_text.substr(5, token_text.length() - 5);
                 break;
               case ::EOLIAN_DOC_TOKEN_MARK_WARNING:
-                new_text += "WARNING: " + token_text;
+                new_text += "<b>WARNING:</b>" + token_text.substr(8, token_text.length() - 8);
                 break;
               case ::EOLIAN_DOC_TOKEN_MARK_REMARK:
-                new_text += "REMARK: " + token_text;
+                new_text += "<b>REMARK:</b>" + token_text.substr(7, token_text.length() - 7);
                 break;
               case ::EOLIAN_DOC_TOKEN_MARK_TODO:
-                new_text += "TODO: " + token_text;
+                new_text += "<b>TODO:</b>" + token_text.substr(5, token_text.length() - 5);
                 break;
               case ::EOLIAN_DOC_TOKEN_MARKUP_MONOSPACE:
                 new_text += "<c>" + token_text + "</c>";