From 14e45cc73b8f361b0ed2d7f1422be658bad286ac Mon Sep 17 00:00:00 2001 From: Yakov Veromeev Date: Mon, 9 Sep 2019 17:10:42 +0300 Subject: [PATCH] Fixed tag not rendering On line 87 guide refers to "code" tag to use in order to preserve whitespaces in documentation examples. This tag is processed by Markdown engine as a tag, not as text, so that it should be wrapped in back-ticks. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 232a0e3..d0a9b1f 100644 --- a/README.md +++ b/README.md @@ -84,7 +84,7 @@ In order for ApexDoc to identify class methods, the method line must contain an | @description | one or more lines that provide an overview of the method| | @param *param name* | a description of what the parameter does| | @return | a description of the return value from the method| -| @example | Example code usage. This will be wrapped in tags to preserve whitespace| +| @example | Example code usage. This will be wrapped in `` tags to preserve whitespace| Example ``` /*******************************************************************************************************