Merge pull request #141 from Xvezda/feature/docs

Add documentation examples

Author: Xvezda

docs/rules/check-throws-tag-type.md

@@ -15,9 +15,54 @@ Default: `false`
 When a literal value is thrown, document its base type rather than the literal type.
 For example, for `throw "foo"`, insert `@throws {string}` instead of `@throws {"foo"}`.
 
+```ts
+// useBaseTypeOfLiteral: true
+/**
+ * @throws {string}
+ */
+function test() {
+  throw 'foo';
+}
+
+// useBaseTypeOfLiteral: false
+/**
+ * @throws {'foo'}
+ */
+function test() {
+  throw 'foo';
+}
+```
+
 ### `preferUnionType`
 
 Default: `true`
 
 When more than one exception can be thrown, the types are added as a union type in the comment.
 If set to `false`, each exception is written on its own line.
+
+```ts
+// preferUnionType: true
+/**
+ * @throws {FooError | BarError}
+ */
+function test() {
+  if (Math.random() < 0.5) {
+    throw new FooError();
+  } else {
+    throw new BarError();
+  }
+}
+
+// preferUnionType: false
+/**
+ * @throws {FooError}
+ * @throws {BarError}
+ */
+function test() {
+  if (Math.random() < 0.5) {
+    throw new FooError();
+  } else {
+    throw new BarError();
+  }
+}
+```

docs/rules/no-undocumented-throws.md

@@ -15,9 +15,54 @@ Default: `false`
 When a literal value is thrown, document its base type rather than the literal type.
 For example, for `throw "foo"`, insert `@throws {string}` instead of `@throws {"foo"}`.
 
+```ts
+// useBaseTypeOfLiteral: true
+/**
+ * @throws {string}
+ */
+function test() {
+  throw 'foo';
+}
+
+// useBaseTypeOfLiteral: false
+/**
+ * @throws {'foo'}
+ */
+function test() {
+  throw 'foo';
+}
+```
+
 ### `preferUnionType`
 
 Default: `true`
 
 When more than one exception can be thrown, the types are added as a union type in the comment.
 If set to `false`, each exception is written on its own line.
+
+```ts
+// preferUnionType: true
+/**
+ * @throws {FooError | BarError}
+ */
+function test() {
+  if (Math.random() < 0.5) {
+    throw new FooError();
+  } else {
+    throw new BarError();
+  }
+}
+
+// preferUnionType: false
+/**
+ * @throws {FooError}
+ * @throws {BarError}
+ */
+function test() {
+  if (Math.random() < 0.5) {
+    throw new FooError();
+  } else {
+    throw new BarError();
+  }
+}
+```