Documentation updates and publishing version

Author: cesarParra

README.md

@@ -13,7 +13,7 @@ the [Java based ApexDoc tool](https://github.com/SalesforceFoundation/ApexDoc) o
 later maintained by Salesforce.org, as that tool is no longer being maintained.
 
 ApexDocs is a Node.js library built on Typescript and hosted on [npm](https://www.npmjs.com/package/@cparra/apexdocs).
-It offers CLI capabilities to automatically docGenerator a set of files that fully document each one of you classes.
+It offers CLI capabilities to automatically document your source code, based on the ApexDoc style of documentation.
 Additionally, it can be imported and consumed directly by your JavaScript code.
 
 There are some key differences between ApexDocs and the Java based ApexDoc tool:
@@ -71,7 +71,10 @@ public class MyClass {
 * Apex docs blocks can now all be in a single line
 * Support for grouping blocks of related code within a class
 * Support for HTML tags
-* And more!
+* OpenApi REST specification generation
+* Support for ignoring files and members from being documented
+* Namespace support
+* And much, much more!
 
 ### Demo
 
@@ -329,6 +332,23 @@ To fix this issue, when not sanitizing HTML, you should wrap any code that conta
 treated as HTML within '\`'
 or within `<code>` tags.
 
+
+### Ignoring files and members
+
+You can ignore files and members by using the `@ignore` tag on any ApexDoc block. If used at the class level, the entire
+file will be ignored. If used at the member level, only that member will be ignored.
+
+Example
+
+ ```apex
+ /**
+  * @ignore
+  */
+ public class MyClass {
+     public static void myMethod() {}
+ }
+ ```
+
 ## Generating OpenApi REST Definitions
 
 ApexDocs supports generating OpenApi 3.1.0 REST definitions based on any `@RestResource` classes in your source code.

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@cparra/apexdocs",
-  "version": "2.13.0-alpha.4",
+  "version": "2.13.0",
   "description": "Library with CLI capabilities to generate documentation for Salesforce Apex classes.",
   "keywords": [
     "apex",
@@ -66,7 +66,7 @@
     ]
   },
   "dependencies": {
-    "@cparra/apex-reflection": "2.2.0",
+    "@cparra/apex-reflection": "2.3.0",
     "chalk": "^4.1.2",
     "fast-xml-parser": "^4.0.1",
     "js-yaml": "^4.1.0",

package.json

@@ -1,7 +1,7 @@
 import { Type } from '@cparra/apex-reflection';
 import ClassFileGeneratorHelper from '../transpiler/markdown/class-file-generatorHelper';
 import { MarkdownFile } from './markdown-file';
-import { stringUtils } from '../util/string-utils';
+import { truncate } from '../util/string-utils';
 import { Settings } from '../settings';
 
 export class MarkdownHomeFile extends MarkdownFile {
@@ -34,7 +34,7 @@ export class MarkdownHomeFile extends MarkdownFile {
         (previous, current) => previous + current + '\n',
         '',
       );
-      this.addText(stringUtils(description, 300));
+      this.addText(truncate(description, 300));
       this.addBlankLine();
     }
   }

src/model/markdown-home-file.ts

@@ -21,7 +21,7 @@ it('should add a path based on the @UrlResource annotation on the class', functi
   const processor = new OpenApiDocsProcessor();
   processor.onProcess(classMirror);
 
-  expect(processor.openApiModel.paths).toHaveProperty('/Account/');
+  expect(processor.openApiModel.paths).toHaveProperty('Account/');
 });
 
 it('should contain a path with a description when the class has an ApexDoc comment', function () {
@@ -37,5 +37,5 @@ it('should contain a path with a description when the class has an ApexDoc comme
   const processor = new OpenApiDocsProcessor();
   processor.onProcess(classMirror);
 
-  expect(processor.openApiModel.paths['/Account/'].description).toBe('My Description');
+  expect(processor.openApiModel.paths['Account/'].description).toBe('My Description');
 });

src/transpiler/openapi/__tests__/open-api-docs-processor.spec.ts

@@ -10,7 +10,6 @@ import { TypeBundle, TypesRepository } from '../../../model/types-repository';
 import { ClassMirror, DocCommentAnnotation, FieldMirror, PropertyMirror } from '@cparra/apex-reflection';
 import { ListObjectType, ReferencedType } from '@cparra/apex-reflection';
 import { ApexDocSchemaObject } from '../../../model/openapi/apex-doc-types';
-import { ReferenceRepository } from '../utils/ReferenceRepository';
 
 type TypeBundleWithIsCollectionAndReferenceOverrides = TypeBundle & {
   originalTypeName: string;

src/transpiler/openapi/parsers/ReferenceBuilder.ts

@@ -1,4 +1,4 @@
-export function stringUtils(str: string, n: number) {
+export function truncate(str: string, n: number) {
   return str.length > n ? str.substr(0, n - 1) + '…' : str;
 }