Fixed issues with optionals not rendering correctly

typedoc2md · Sep 28, 2017 · 3290d25 · 3290d25
1 parent 262e863
commit 3290d25
Show file tree

Hide file tree

Showing 48 changed files with 134 additions and 263 deletions.
diff --git a/src/theme/partials/member.signature.body.hbs b/src/theme/partials/member.signature.body.hbs
@@ -1,6 +1,7 @@
 
-
+{{#unless hideSources}}
 {{ compileSources this}}
+{{/unless}}
 
 {{> comment}}
 

diff --git a/src/theme/partials/member.signature.title.hbs b/src/theme/partials/member.signature.title.hbs
@@ -1,5 +1,5 @@
 {{#compact}}
-{{#unless hideName}}{{getMemberSymbol kindString}}**{{{name}}}**{{/unless}}
+{{getMemberSymbol kindString}}{{#unless hideName}}**{{{name}}}**{{/unless}}
 {{#if typeParameters}}
 {{#each typeParameters}}
 {{#if @index}}, {{/if}}

diff --git a/src/theme/partials/parameter.hbs b/src/theme/partials/parameter.hbs
@@ -12,14 +12,7 @@
 
 {{#if indexSignature}}
 
-{{#compact}}
-[
-{{#each indexSignature.parameters}}
- {{#if flags.isRest}}...{{/if}}{{name}}:&nbsp;{{#with type}}{{>type}}{{/with}}
-{{/each}}
-  ]:&nbsp;
-{{#with indexSignature.type}}{{>type}}{{/with}}
-{{/compact}}
+[{{#each indexSignature.parameters}}{{#if flags.isRest}}...{{/if}}{{name}}:&nbsp;{{#with type}}{{>type}}{{/with}}{{/each}}]: {{#with indexSignature.type}}{{>type}}{{/with}}
 
 {{#with indexSignature}}
 {{> comment}}
@@ -33,29 +26,14 @@
 {{/if}}
 
 {{#each children}}
-{{#if signatures}}
-{{#compact}}
-{{#if flags.isRest}}...{{/if}}
-{{{ name}}}
-{{#if isOptional}}?{{/if}}
-:&nbsp;
-function
-{{/compact}}
 
+{{#if signatures}}
+{{#if flags.isRest}}...{{/if}} {{{ name}}} {{#if isOptional}}?{{/if}}: function
 {{> member.signatures}}
-{{else}}
-{{#compact}}
-{{#each flags}}
-{{this}}
-{{/each}}
 
-{{#if flags.isRest}}...{{/if}}
-{{{ name}}}
+{{else}}
 
-{{#if flags.isOptional}}?{{/if}}
-:&nbsp;
-{{#with type}}{{>type}}{{/with}}
-{{/compact}}
+{{#each flags}}«{{this}}» {{/each}} {{#if flags.isRest}}...{{/if}}{{{ name}}}{{#if flags.isOptional}}?{{/if}}: {{#with type}}{{>type}}{{/with}}
 
 {{> comment}}
 

diff --git a/src/theme/partials/type.hbs b/src/theme/partials/type.hbs
@@ -28,7 +28,7 @@
 {{#if value}}
 "{{value}}"
 {{else}}
-{{this}}
+`{{this}}`
 {{/if}}
 {{/if}}
 {{#if typeArguments}}

diff --git a/tests/mocks/bitbucket/README.md b/tests/mocks/bitbucket/README.md
@@ -40,6 +40,11 @@
 * [IPrintNameInterface](interfaces/iprintnameinterface.md)
 
 
+### Type aliases
+
+* [SomeOptions](#markdown-header-someoptions)
+
+
 ### Variables
 
 * [Promise](#markdown-header-promise)
@@ -80,6 +85,43 @@
 
 
 ---
+# Type aliases
+
+
+###  SomeOptions
+
+**Τ SomeOptions**:  *`object`* 
+
+*Defined in [basic-types.ts:49](https://bitbucket.org/owner/repository_name/src/master/src/basic-types.ts?fileviewer&amp;#x3D;file-view-default#basic-types.ts-49)*
+
+
+#### Type declaration
+
+
+
+
+«Optional»  aFunction?: `function`
+
+
+
+
+►(): `void`
+
+
+
+
+
+**Returns:** `void`
+
+
+
+
+
+
+
+___
+
+
 # Variables
 
 
@@ -254,8 +296,7 @@ ___
 
 ###  createSomething
 
-► **createSomething**(): object
-
+► **createSomething**(): `object`
 
 
 
@@ -268,7 +309,7 @@ A function that returns an object. Also no type information is given, the object
 
 
 
-**Returns:** object
+**Returns:** `object`
 
 
 
@@ -284,7 +325,6 @@ ___
 
 
 
-
 *Defined in [functions.ts:11](https://bitbucket.org/owner/repository_name/src/master/src/functions.ts?fileviewer&amp;#x3D;file-view-default#functions.ts-11)*
 
 
@@ -310,7 +350,6 @@ ___
 
 
 
-
 *Defined in [functions.ts:38](https://bitbucket.org/owner/repository_name/src/master/src/functions.ts?fileviewer&amp;#x3D;file-view-default#functions.ts-38)*
 
 
@@ -346,7 +385,6 @@ ___
 
 
 
-
 *Defined in [functions.ts:58](https://bitbucket.org/owner/repository_name/src/master/src/functions.ts?fileviewer&amp;#x3D;file-view-default#functions.ts-58)*
 
 
@@ -386,7 +424,6 @@ ___
 
 
 
-
 *Defined in [functions.ts:170](https://bitbucket.org/owner/repository_name/src/master/src/functions.ts?fileviewer&amp;#x3D;file-view-default#functions.ts-170)*
 
 
@@ -414,7 +451,6 @@ ___
 
 
 
-
 *Defined in [functions.ts:48](https://bitbucket.org/owner/repository_name/src/master/src/functions.ts?fileviewer&amp;#x3D;file-view-default#functions.ts-48)*
 
 
@@ -449,7 +485,6 @@ ___
 
 
 
-
 *Defined in [functions.ts:74](https://bitbucket.org/owner/repository_name/src/master/src/functions.ts?fileviewer&amp;#x3D;file-view-default#functions.ts-74)*
 
 
@@ -485,7 +520,6 @@ ___
 
 
 
-
 *Defined in [functions.ts:116](https://bitbucket.org/owner/repository_name/src/master/src/functions.ts?fileviewer&amp;#x3D;file-view-default#functions.ts-116)*
 
 
@@ -527,7 +561,6 @@ ___
 
 
 
-
 *Defined in [functions.ts:6](https://bitbucket.org/owner/repository_name/src/master/src/functions.ts?fileviewer&amp;#x3D;file-view-default#functions.ts-6)*
 
 
@@ -551,8 +584,7 @@ ___
 
 ► **multipleSignatures**(value: *`string`*): `string`
 
-► **multipleSignatures**(value: *object*): `string`
-
+► **multipleSignatures**(value: *`object`*): `string`
 
 
 
@@ -577,7 +609,6 @@ This is the first signature of a function with multiple signatures.
 
 
 
-
 *Defined in [functions.ts:91](https://bitbucket.org/owner/repository_name/src/master/src/functions.ts?fileviewer&amp;#x3D;file-view-default#functions.ts-91)*
 
 
@@ -589,7 +620,7 @@ This is the second signature of a function with multiple signatures.
 
 | Param | Type | Description |
 | ------ | ------ | ------ |
-| value | object   |  An object containing the name value. |
+| value | `object`   |  An object containing the name value. |
 
 
 
@@ -612,7 +643,6 @@ ___
 
 
 
-
 *Defined in [private-members.ts:10](https://bitbucket.org/owner/repository_name/src/master/src/private-members.ts?fileviewer&amp;#x3D;file-view-default#private-members.ts-10)*
 
 
@@ -635,7 +665,6 @@ ___
 
 
 
-
 *Defined in [functions.ts:191](https://bitbucket.org/owner/repository_name/src/master/src/functions.ts?fileviewer&amp;#x3D;file-view-default#functions.ts-191)*
 
 
@@ -658,7 +687,6 @@ ___
 
 
 
-
 *Defined in [functions.ts:177](https://bitbucket.org/owner/repository_name/src/master/src/functions.ts?fileviewer&amp;#x3D;file-view-default#functions.ts-177)*
 
 
@@ -681,7 +709,6 @@ ___
 
 
 
-
 *Defined in [functions.ts:183](https://bitbucket.org/owner/repository_name/src/master/src/functions.ts?fileviewer&amp;#x3D;file-view-default#functions.ts-183)*
 
 
@@ -700,8 +727,7 @@ ___
 
 ###  returnTypeObject
 
-► **returnTypeObject**(properties: *`object`*): object
-
+► **returnTypeObject**(properties: *`object`*): `object`
 
 
 
@@ -719,7 +745,7 @@ ___
 
 
 
-**Returns:** object
+**Returns:** `object`
 
 
 
@@ -735,7 +761,6 @@ ___
 
 
 
-
 *Defined in [functions.ts:23](https://bitbucket.org/owner/repository_name/src/master/src/functions.ts?fileviewer&amp;#x3D;file-view-default#functions.ts-23)*
 
 
@@ -806,7 +831,6 @@ ___
 
 
 
-
 *Defined in [basic-types.ts:42](https://bitbucket.org/owner/repository_name/src/master/src/basic-types.ts?fileviewer&amp;#x3D;file-view-default#basic-types.ts-42)*
 
 

diff --git a/tests/mocks/bitbucket/classes/baseclass.md b/tests/mocks/bitbucket/classes/baseclass.md
@@ -68,7 +68,6 @@ This is a simple example on how to use BaseClass.
 ### ⊕ **new BaseClass**(source: *[BaseClass](baseclass.md)*): [BaseClass](baseclass.md)
 
 
-
 *Defined in [classes.ts:70](https://bitbucket.org/owner/repository_name/src/master/src/classes.ts?fileviewer&amp;#x3D;file-view-default#classes.ts-70)*
 
 
@@ -85,7 +84,6 @@ This is a simple example on how to use BaseClass.
 
 **Returns:** [BaseClass](baseclass.md)
 
-
 *Defined in [classes.ts:72](https://bitbucket.org/owner/repository_name/src/master/src/classes.ts?fileviewer&amp;#x3D;file-view-default#classes.ts-72)*
 
 
@@ -152,7 +150,6 @@ ___
 
 
 
-
 *Defined in [classes.ts:129](https://bitbucket.org/owner/repository_name/src/master/src/classes.ts?fileviewer&amp;#x3D;file-view-default#classes.ts-129)*
 
 
@@ -187,7 +184,6 @@ ___
 
 
 
-
 *Implementation of [INameInterface](../interfaces/inameinterface.md).[getName](../interfaces/inameinterface.md#markdown-header-getname)*
 
 *Defined in [classes.ts:94](https://bitbucket.org/owner/repository_name/src/master/src/classes.ts?fileviewer&amp;#x3D;file-view-default#classes.ts-94)*
@@ -219,7 +215,6 @@ ___
 
 
 
-
 *Defined in [classes.ts:117](https://bitbucket.org/owner/repository_name/src/master/src/classes.ts?fileviewer&amp;#x3D;file-view-default#classes.ts-117)*
 
 
@@ -255,7 +250,6 @@ ___
 
 
 
-
 *Defined in [classes.ts:153](https://bitbucket.org/owner/repository_name/src/master/src/classes.ts?fileviewer&amp;#x3D;file-view-default#classes.ts-153)*
 
 
@@ -292,7 +286,6 @@ ___
 
 
 
-
 *Defined in [classes.ts:146](https://bitbucket.org/owner/repository_name/src/master/src/classes.ts?fileviewer&amp;#x3D;file-view-default#classes.ts-146)*
 
 
@@ -322,7 +315,6 @@ ___
 
 
 
-
 *Defined in [classes.ts:106](https://bitbucket.org/owner/repository_name/src/master/src/classes.ts?fileviewer&amp;#x3D;file-view-default#classes.ts-106)*