From 31a7bf2a22f7e9cfa3ec309cdff626a2ea228aab Mon Sep 17 00:00:00 2001
From: Marco Gonzalez <marcogrcr@gmail.com>
Date: Sat, 15 Feb 2020 07:10:58 -0800
Subject: Updated "Output options" > "comments" in README.md (#3717)

Expanded the current documentation to include:

- What the value of `"some"` means based on `lib/output.js`.
- Information about the `Function` overload parameters and expected output.
---
 README.md | 10 ++++++++--
 1 file changed, 8 insertions(+), 2 deletions(-)

(limited to 'README.md')

diff --git a/README.md b/README.md
index 21dfabf9..7e07cc87 100644
--- a/README.md
+++ b/README.md
@@ -848,8 +848,14 @@ can pass additional arguments that control the code output:
   statement.
 
 - `comments` (default `false`) -- pass `true` or `"all"` to preserve all
-  comments, `"some"` to preserve some comments, a regular expression string
-  (e.g. `/^!/`) or a function.
+  comments, `"some"` to preserve multi-line comments that contain `@cc_on`,
+  `@license`, or `@preserve` (case-insensitive), a regular expression string
+  (e.g. `/^!/`), or a function which returns `boolean`, e.g.
+  ```js
+  function(node, comment) {
+      return comment.value.indexOf("@type " + node.TYPE) >= 0;
+  }
+  ```
 
 - `indent_level` (default `4`)
 
-- 
cgit v1.2.3