fix: tsc no longer filters * in docs

Author: andnp

README.md

@@ -274,11 +274,11 @@ A `Validator` will always maintain a valid json schema representation of the typ
 The underlying json schema can always be accessed with `getSchema()`.
 ###### Example:
  ```typescript
-const stringValidator = new Validator<string>({ type: 'string' });
-const numberValidator = new Validator<number>({ type: 'number' });
-const strOrNum = new Validator<string | number>({ oneOf: [ { type: 'string' }, { type: 'number' } ]});
-const strOrNum2 = stringValidator.or(numberValidator);
-```
+ const stringValidator = new Validator<string>({ type: 'string' });
+ const numberValidator = new Validator<number>({ type: 'number' });
+ const strOrNum = new Validator<string | number>({ oneOf: [ { type: 'string' }, { type: 'number' } ]});
+ const strOrNum2 = stringValidator.or(numberValidator);
+ ```
 
 ### Validator.and
 Creates a new validator that is true whenever the data matches `this` _and_ `v`.

scripts/generateDocumentation.ts

@@ -61,11 +61,20 @@ const buildTypeInfoFromNode = (fileName: string, checker: tsc.TypeChecker, node:
         .map(tag => tag.text)
         .filter(text => !!text)[0];
 
+    const cleanedExample = example && example
+        .split('\n')
+        .map(line =>
+            line.trimLeft().startsWith('*')
+                ? line.trimLeft().substr(1).trimLeft()
+                : line
+        )
+        .join('\n');
+
     const typeInfo: TypeInfo = {
+        example: cleanedExample,
         typeName,
         parameterDocs,
         returnDocs: returnDocs[0],
-        example,
         description,
         fileName,
     };