Skip to content

Commit ced8735

Browse files
typhonrttyphonrt
committed
updated names for doc data generators
1 parent 723701f commit ced8735

16 files changed

+52
-37
lines changed

Diff for: ‎src/doc/FileDoc.js

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
1-
import fs from 'fs';
1+
import fs from 'fs';
22

3-
import AbstractDoc from './abstract/AbstractDoc.js';
3+
import DocBase from './base/DocBase.js';
44

55
/**
66
* Doc Class from source file.
77
*/
8-
export default class FileDoc extends AbstractDoc
8+
export default class FileDoc extends DocBase
99
{
1010
/**
1111
* Create doc data statically held. File docs are the module, so pass `null` as the module ID to AbstractDoc.

Diff for: ‎src/doc/MemoryDoc.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
import AbstractDoc from './abstract/AbstractDoc.js';
1+
import DocBase from './base/DocBase.js';
22

33
/**
44
* Doc from source code in memory. (Used for dynamically loading virtual external & typedef types).
55
*/
6-
export default class MemoryDoc extends AbstractDoc
6+
export default class MemoryDoc extends DocBase
77
{
88
/**
99
* Create doc data statically held. Memory docs are the module, so pass `null` as the module ID to AbstractDoc.

Diff for: ‎src/doc/ExternalDoc.js renamed to ‎src/doc/VirtualExternalDoc.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
import AbstractDoc from './abstract/AbstractDoc.js';
1+
import DocBase from './base/DocBase.js';
22

33
/**
44
* Doc Class from virtual comment node of external.
@@ -7,7 +7,7 @@ import AbstractDoc from './abstract/AbstractDoc.js';
77
*
88
* `@external`
99
*/
10-
export default class ExternalDoc extends AbstractDoc
10+
export default class ExternalDoc extends DocBase
1111
{
1212
/**
1313
* The following methods provide the @xxx tags / annotations supported in ExternalDoc. Adding methods makes it easy

Diff for: ‎src/doc/abstract/AbstractMemberDoc.js renamed to ‎src/doc/base/ClassMemberDocBase.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
import AbstractDoc from './AbstractDoc.js';
1+
import DocBase from './DocBase.js';
22

33
/**
44
* Provides the common base for documenting member expressions.
@@ -13,7 +13,7 @@ import AbstractDoc from './AbstractDoc.js';
1313
*
1414
* _$type()
1515
*/
16-
export default class AbstractMemberDoc extends AbstractDoc
16+
export default class ClassMemberDocBase extends DocBase
1717
{
1818
/** specify ``member`` to kind. */
1919
static _$kind()

Diff for: ‎src/doc/abstract/AbstractMethodDoc.js renamed to ‎src/doc/base/ClassMethodDocBase.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
import AbstractDoc from './AbstractDoc.js';
1+
import DocBase from './DocBase.js';
22

33
/**
44
* Provides the common base for documenting class methods.
@@ -23,6 +23,6 @@ import AbstractDoc from './AbstractDoc.js';
2323
*
2424
* _$type()
2525
*/
26-
export default class AbstractMethodDoc extends AbstractDoc
26+
export default class ClassMethodDocBase extends DocBase
2727
{
2828
}

Diff for: ‎src/doc/abstract/AbstractClassPropertyDoc.js renamed to ‎src/doc/base/ClassPropertyDocBase.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
import AbstractDoc from './AbstractDoc.js';
1+
import DocBase from './DocBase.js';
22

33
/**
44
* Provides the common base for documenting class properties.
@@ -13,7 +13,7 @@ import AbstractDoc from './AbstractDoc.js';
1313
*
1414
* _$type()
1515
*/
16-
export default class AbstractClassPropertyDoc extends AbstractDoc
16+
export default class ClassPropertyDocBase extends DocBase
1717
{
1818
/** specify ``member`` to kind. */
1919
static _$kind()

Diff for: ‎src/doc/abstract/AbstractDoc.js renamed to ‎src/doc/base/DocBase.js

+5-5
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,15 @@ import fs from 'fs';
22
import path from 'path';
33

44
/**
5-
* Abstract Doc Class.
5+
* The base doc.
66
*
7-
* The following tags / annotations are supported by AbstractDoc and children implementations:
7+
* The following tags / annotations are supported by DocBase and children implementations:
88
*
99
* `@abstract`, `@access`, `@deprecated`, `@desc`, `@emits`, `@example`, `@experimental`, `@ignore`, `@listens`,
1010
* `@param`, `@override`, `@private`, `@property`, `@protected`, `@public`, `@return`, `@returns`, `@see`, `@since`,
1111
* `@throws`, `@todo`, `@type`, `@version`
1212
*/
13-
export default class AbstractDoc
13+
export default class DocBase
1414
{
1515
/**
1616
* Creates doc data statically held.
@@ -29,7 +29,7 @@ export default class AbstractDoc
2929
*
3030
* @param {EventProxy} eventbus - An event proxy for the main eventbus.
3131
*
32-
* @returns {AbstractDoc}
32+
* @returns {DocBase}
3333
*/
3434
static create(docID, moduleID, ast, node, pathResolver, commentTags = [], eventbus)
3535
{
@@ -346,7 +346,7 @@ export default class AbstractDoc
346346
}
347347

348348
/**
349-
* The following methods provide the @xxx tags / annotations supported in AbstractDoc. Adding methods makes it easy
349+
* The following methods provide the @xxx tags / annotations supported in DocBase. Adding methods makes it easy
350350
* to detect any unknown tags when a method is missing. Child classes may also add the tags that they support.
351351
*/
352352

Diff for: ‎src/doc/abstract/AbstractAssignmentDoc.js renamed to ‎src/doc/base/ModuleAssignmentDocBase.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
import AbstractModuleDoc from './AbstractModuleDoc.js';
1+
import ModuleDocBase from './ModuleDocBase.js';
22

33
/**
44
* Provides the common base for documenting variable assignment.
@@ -7,7 +7,7 @@ import AbstractModuleDoc from './AbstractModuleDoc.js';
77
*
88
* _$name()
99
*/
10-
export default class AbstractAssignmentDoc extends AbstractModuleDoc
10+
export default class AssignmentDocBase extends ModuleDocBase
1111
{
1212
/**
1313
* specify ``variable`` to kind.

Diff for: ‎src/doc/abstract/AbstractClassDoc.js renamed to ‎src/doc/base/ModuleClassDocBase.js

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
import fs from 'fs';
1+
import fs from 'fs';
22

3-
import AbstractModuleDoc from './AbstractModuleDoc.js';
3+
import ModuleDocBase from './ModuleDocBase.js';
44

55
/**
66
* Provides the common base for documenting classes.
@@ -15,7 +15,7 @@ import AbstractModuleDoc from './AbstractModuleDoc.js';
1515
*
1616
* _$extends()
1717
*/
18-
export default class AbstractClassDoc extends AbstractModuleDoc
18+
export default class ModuleClassDocBase extends ModuleDocBase
1919
{
2020
/**
2121
* read selection text in file.

Diff for: ‎src/doc/abstract/AbstractModuleDoc.js renamed to ‎src/doc/base/ModuleDocBase.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
import AbstractDoc from './AbstractDoc.js';
1+
import DocBase from './DocBase.js';
22

33
/**
44
* Contains methods required for doc types that need module import / export support.
55
*/
6-
export default class AbstractModuleDoc extends AbstractDoc
6+
export default class ModuleDocBase extends DocBase
77
{
88
/**
99
* decide `export`.

Diff for: ‎src/doc/abstract/AbstractFunctionDoc.js renamed to ‎src/doc/base/ModuleFunctionDocBase.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
import AbstractModuleDoc from './AbstractModuleDoc.js';
1+
import ModuleDocBase from './ModuleDocBase.js';
22

33
/**
44
* Provides the common base for documenting functions (module scope).
@@ -15,7 +15,7 @@ import AbstractModuleDoc from './AbstractModuleDoc.js';
1515
*
1616
* _$return()
1717
*/
18-
export default class AbstractFunctionDoc extends AbstractModuleDoc
18+
export default class ModuleFunctionDocBase extends ModuleDocBase
1919
{
2020
/** specify ``function`` to kind. */
2121
static _$kind()

Diff for: ‎src/doc/abstract/AbstractVariableDoc.js renamed to ‎src/doc/base/ModuleVariableDocBase.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
import AbstractModuleDoc from './AbstractModuleDoc.js';
1+
import ModuleDocBase from './ModuleDocBase.js';
22

33
/**
44
* Provides the common base for documenting variable declarations.
@@ -7,7 +7,7 @@ import AbstractModuleDoc from './AbstractModuleDoc.js';
77
*
88
* _$name()
99
*/
10-
export default class AbstractVariableDoc extends AbstractModuleDoc
10+
export default class ModuleVariableDocBase extends ModuleDocBase
1111
{
1212
/** specify ``variable`` to kind. */
1313
static _$kind()

Diff for: ‎src/doc/abstract/AbstractTestDoc.js renamed to ‎src/doc/base/TestDocBase.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
import AbstractDoc from './AbstractDoc.js';
1+
import DocBase from './DocBase.js';
22

33
/**
44
* Provides the common base for documenting tests.
@@ -15,7 +15,7 @@ import AbstractDoc from './AbstractDoc.js';
1515
*
1616
* _$memberof()
1717
*/
18-
export default class AbstractTestDoc extends AbstractDoc
18+
export default class TestDocBase extends DocBase
1919
{
2020

2121
/**

Diff for: ‎src/doc/abstract/AbstractTypedefDoc.js renamed to ‎src/doc/base/VirtualTypedefDocBase.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
import AbstractDoc from './AbstractDoc.js';
1+
import DocBase from './DocBase.js';
22

33
/**
44
* Provides the common base for virtual comment node `@typedef`.
@@ -11,7 +11,7 @@ import AbstractDoc from './AbstractDoc.js';
1111
*
1212
* _$memberof()
1313
*/
14-
export default class AbstractTypedefDoc extends AbstractDoc
14+
export default class VirtualTypedefDocBase extends DocBase
1515
{
1616
/**
1717
* The following methods provide the @xxx tags / annotations supported in AbstractTypedefDoc. Adding methods makes it

Diff for: ‎src/doc/base/index.js

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
// Export common docs
2+
export { default as ClassMemberDocBase } from './ClassMemberDocBase.js';
3+
export { default as ClassMethodDocBase } from './ClassMethodDocBase.js';
4+
export { default as ClassPropertyDocBase } from './ClassPropertyDocBase.js';
5+
export { default as DocBase } from './DocBase.js';
6+
export { default as ModuleAssignmentDocBase } from './ModuleAssignmentDocBase.js';
7+
export { default as ModuleClassDocBase } from './ModuleClassDocBase.js';
8+
export { default as ModuleDocBase } from './ModuleDocBase.js';
9+
export { default as ModuleFunctionDocBase } from './ModuleFunctionDocBase.js';
10+
export { default as ModuleVariableDocBase } from './ModuleVariableDocBase.js';
11+
export { default as TestDocBase } from './TestDocBase.js';
12+
export { default as VirtualTypedefDocBase } from './VirtualTypedefDocBase.js';

Diff for: ‎src/doc/index.js

+7-4
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
1+
// Export common base docs
2+
export * as Base from './base/';
3+
14
// Export common docs
2-
export { default as ExternalDoc } from './ExternalDoc.js';
3-
export { default as FileDoc } from './FileDoc.js';
4-
export { default as MemoryDoc } from './MemoryDoc.js';
5-
export { default as TestFileDoc } from './TestFileDoc.js';
5+
export { default as FileDoc } from './FileDoc.js';
6+
export { default as MemoryDoc } from './MemoryDoc.js';
7+
export { default as TestFileDoc } from './TestFileDoc.js';
8+
export { default as VirtualExternalDoc } from './VirtualExternalDoc.js';
69

0 commit comments

Comments
 (0)