From 5df8fab4637865cc895bc698410efedc765dfd8c Mon Sep 17 00:00:00 2001 From: Kurtis Rader Date: Sat, 23 Apr 2016 21:14:00 -0700 Subject: replace command with \outp in docs Doxygen has been warning that `` and `` are not valid XML/HTML commands since commit cb6d5d76 on 20016-04-04. That's primarily because there is at present no way to tell Doxygen to recognize new XML/HTML tags. The actual errors look like this: ``` .../string.doxygen:187: warning: Unsupported xml/html tag found ``` I hate build errors since they a) cause needless concern, and b) make it harder to notice when I've introduced a new error. So switch from XML/C## style markup to Doxygen style markup for the "outp" annotation. --- doc_src/FORMATTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'doc_src/FORMATTING.md') diff --git a/doc_src/FORMATTING.md b/doc_src/FORMATTING.md index df6de6f8..4b4b2338 100644 --- a/doc_src/FORMATTING.md +++ b/doc_src/FORMATTING.md @@ -158,10 +158,10 @@ The following can be used in \\fish blocks to render some fish scenarios. These - ``: \Matched\ items, such as tab completions. - ``: Matched items \searched\ for, like grep results. - ``: \This would be shown as an error.\ -- ``: \This test will not be parsed for fish markup.\ -- ``: \This would be rendered as command/script output.\ +- ``: \This text will not be parsed for fish markup.\ - ``: Render the contents with a preceding backslash. Useful when presenting output. - `{{` and `}}`: Required when wanting curly braces in regular expression example. +- `\\outp`: \\outp\{This would be rendered as command/script output.\} ### Prompts and cursors -- cgit v1.2.3