Feature: enum plugin

packages/ts-docs-gen/examples/simple/docs/api/index.md

@@ -1,28 +1,112 @@
-[ClassDeclaration-0]: index.md#class-world
-[ClassDeclaration-1]: index.md#class-earth
-[FunctionDeclaration-0]: exported-functions.md#function-foo
 # index
 
-## class: World
+## Uogos
 
-## class: Earth
+Some information
+2nd line of some information
+3rd line of some information
+4th line of some information
+5th line of some information.
 
-## Hello
+deprecated
+beta
 
 ```typescript
-const Hello: World & Earth;
+enum Uogos {
+     Jokie = "jokie",
+     Braskes = "braskes"
+}
 ```
 
-### Type
+| Name    | Value     |
+| ------- | --------- |
+| Jokie   | "jokie"   |
+| Braskes | "braskes" |
+
+## Skaiciai
+
+
+
+```typescript
+enum Skaiciai {
+     Nulis = 0,
+     Vienas = 1,
+     Du = 2
+}
+```
+
+| Name   | Value |
+| ------ | ----- |
+| Nulis  | 0     |
+| Vienas | 1     |
+| Du     | 2     |
+
+## Sarasas
+
+
+
+```typescript
+enum Sarasas {
+     Pirmas = 0,
+     Antras = 1,
+     Trecias = 2
+}
+```
+
+| Name    | Value | Description            |
+| ------- | ----- | ---------------------- |
+| Pirmas  | 0     | Pirmo description'as.  |
+| Antras  | 1     | Antro description'as.  |
+| Trecias | 2     | Trečio description'as. |
+
+## ConstSkaiciai
+
+
+
+```typescript
+enum ConstSkaiciai {
+     PirmasC = 0,
+     AntrasC = 1,
+     TreciasC = 2
+}
+```
+
+| Name     | Value |
+| -------- | ----- |
+| PirmasC  | 0     |
+| AntrasC  | 1     |
+| TreciasC | 2     |
+
+## ConstSarasas
 
-[World][ClassDeclaration-0] & [Earth][ClassDeclaration-1]
 
-## FooFunc
 
 ```typescript
-const FooFunc: () => string;
+enum ConstSarasas {
+     PirmasC = 0,
+     AntrasC = 1,
+     TreciasC = 2
+}
 ```
 
-### Type
+| Name     | Value | Description            |
+| -------- | ----- | ---------------------- |
+| PirmasC  | 0     | Pirmo description'as.  |
+| AntrasC  | 1     | Antro description'as.  |
+| TreciasC | 2     | Trečio description'as. |
+
+## ConstUogos
+
+
+
+```typescript
+enum ConstUogos {
+     Jokie = "jokie",
+     Braskes = "braskes"
+}
+```
 
-[Foo][FunctionDeclaration-0]
+| Name    | Value     |
+| ------- | --------- |
+| Jokie   | "jokie"   |
+| Braskes | "braskes" |

packages/ts-docs-gen/examples/simple/index.ts

@@ -1,13 +1,13 @@
 // tslint:disable
 
-import { Foo } from "./exported-functions";
+// import { Foo } from "./exported-functions";
 
-export class World { }
-export class Earth { }
+// export class World { }
+// export class Earth { }
 
-export declare const Hello: World & Earth;
+// export declare const Hello: World & Earth;
 
-export const FooFunc = Foo;
+// export const FooFunc = Foo;
 
 // export function Foo(): string {
 //     return "foo";
@@ -51,12 +51,12 @@ export const FooFunc = Foo;
 //     <TValue>(param1: TValue, param2: TValue): boolean;
 // }
 
-/**
- * Some JSdoc information.
- * 2nd line of some JSdoc information.
- * @summary Some summary about this package version.
- * @summary 2nd of some summary about this package version.
- */
+// /**
+//  * Some JSdoc information.
+//  * 2nd line of some JSdoc information.
+//  * @summary Some summary about this package version.
+//  * @summary 2nd of some summary about this package version.
+//  */
 // export const itemsList: string[] = ["a"];
 
 // export function Ok(isIt: boolean): boolean {
@@ -71,22 +71,68 @@ export const FooFunc = Foo;
 //     export const name = "some-kind-of-module";
 // }
 
-// export enum Uogos {
-//     Jokie = "jokie",
-//     Braskes = "braskes"
-// }
-
-// export enum Skaiciai {
-//     Nulis = 0,
-//     Vienas = 1,
-//     Du = 2
-// }
-
-// export enum Sarasas {
-//     Pirmas,
-//     Antras,
-//     Trecias
-// }
+/**
+ * Some information
+ * 2nd line of some information
+ * 3rd line of some information
+ * 4th line of some information
+ * 5th line of some information
+ * @summary Some summary about this package version.
+ * @summary 2nd of some summary about this package version.
+ * @deprecated
+ * @beta
+ */
+export enum Uogos {
+    Jokie = "jokie",
+    Braskes = "braskes"
+}
+
+export enum Skaiciai {
+    Nulis = 0,
+    Vienas = 1,
+    Du = 2
+}
+
+export enum Sarasas {
+    /**
+     * Pirmo description'as
+     */
+    Pirmas,
+    /**
+     * Antro description'as
+     */
+    Antras,
+    /**
+     * Trečio description'as
+     */
+    Trecias
+}
+
+export const enum ConstSkaiciai {
+    PirmasC = 0,
+    AntrasC = 1,
+    TreciasC = 2
+}
+
+export const enum ConstSarasas {
+    /**
+     * Pirmo description'as
+     */
+    PirmasC,
+    /**
+     * Antro description'as
+     */
+    AntrasC,
+    /**
+     * Trečio description'as
+     */
+    TreciasC
+}
+
+export const enum ConstUogos {
+    Jokie = "jokie",
+    Braskes = "braskes"
+}
 
 // export interface Boo {
 //     Boos: string[];

packages/ts-docs-gen/package.json

@@ -15,7 +15,7 @@
   "engine": "node >= 7.5.0",
   "author": "simplrjs <simplr@quatrodev.com> (https://github.com/simplrjs)",
   "dependencies": {
-    "@simplrjs/markdown": "0.1.0-beta",
+    "@simplrjs/markdown": "^1.0.0",
     "@types/fs-extra": "^4.0.5",
     "fast-glob": "^1.0.1",
     "fs-extra": "^4.0.2",

packages/ts-docs-gen/src/contracts/plugin-data.ts

@@ -1,9 +1,11 @@
+import { Contracts, ExtractDto } from "ts-extractor";
+
 import { ReferenceTuple } from "./reference-tuple";
 import { RenderItemOutputDto } from "./render-item-output-dto";
-import { Contracts } from "ts-extractor";
 
 export interface PluginData<TKind = Contracts.ApiItemDto> {
     Reference: ReferenceTuple;
     ApiItem: TKind;
+    ExtractedData: ExtractDto;
     GetItem(entryFile: Contracts.ApiSourceFileDto, reference: ReferenceTuple): RenderItemOutputDto;
 }

packages/ts-docs-gen/src/default-plugins.ts

@@ -1,5 +1,7 @@
 import { ApiVariablePlugin } from "./plugins/api-variable-plugin";
+import { ApiEnumPlugin } from "./plugins/api-enum-plugin";
 
 export const DefaultPlugins = [
-    new ApiVariablePlugin()
+    new ApiVariablePlugin(),
+    new ApiEnumPlugin()
 ];