Skip to content

Commit

Permalink
feat: Use new demos from asciinema
Browse files Browse the repository at this point in the history
  • Loading branch information
kkoomen committed Jul 21, 2019
1 parent 20ce496 commit 304b104
Show file tree
Hide file tree
Showing 4 changed files with 33 additions and 42 deletions.
15 changes: 3 additions & 12 deletions doc/demos/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Supported:
- Class methods
- Functions

[Demo](https://vdoge.kimkoomen.nl/demos/doge-demo-php.gif)
[![Demo PHP](https://asciinema.org/a/OvTglKYTEH0FiYKQO3X0H23oB.svg)](https://asciinema.org/a/OvTglKYTEH0FiYKQO3X0H23oB)

## JavaScript

Expand All @@ -38,7 +38,7 @@ Supported:

All of the above is _also_ supported for TypeScript and NodeJS.

[Demo](https://vdoge.kimkoomen.nl/demos/doge-demo-javascript.gif)
[![Demo JavaScript](https://asciinema.org/a/KUvRSPGyFVI0dKsblEa41RG3x.svg)](https://asciinema.org/a/KUvRSPGyFVI0dKsblEa41RG3x)

## Python

Expand All @@ -51,13 +51,4 @@ Supported:
- Google
- Python 3.7+ type hints

[Demo](https://vdoge.kimkoomen.nl/demos/doge-demo-python.gif)

## Scala

Supported:
- Functions
- Methods
- Classes

[Demo](https://vdoge.kimkoomen.nl/demos/doge-demo-scala.gif)
[![Demo Python](https://asciinema.org/a/QKwuUrZphWPD6eZ3mowumkA1O.svg)](https://asciinema.org/a/QKwuUrZphWPD6eZ3mowumkA1O)
16 changes: 8 additions & 8 deletions test/filetypes/javascript/classes.vader
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,13 @@ Do (trigger doge):

Expect javascript (generated comment with nothing but the text 'TODO'):
/**
* TODO
* [TODO:description]
*
*/
class Child {}

/**
* TODO
* [TODO:description]
*
*/
export class Child {}
Expand All @@ -39,14 +39,14 @@ Do (trigger doge):

Expect javascript (generated comment with @extends):
/**
* TODO
* [TODO:description]
*
* @extends Parent
*/
class Child extends Parent {}

/**
* TODO
* [TODO:description]
*
* @extends Parent
*/
Expand All @@ -67,14 +67,14 @@ Do (trigger doge):

Expect javascript (generated comment with @implements tag):
/**
* TODO
* [TODO:description]
*
* @implements CustomInterfaceName
*/
class Child implements CustomInterfaceName {}

/**
* TODO
* [TODO:description]
*
* @implements CustomInterfaceName
*/
Expand All @@ -95,15 +95,15 @@ Do (trigger doge):

Expect javascript (generated comment with @extends and @implements tags):
/**
* TODO
* [TODO:description]
*
* @extends Parent
* @implements CustomInterfaceName
*/
class Child extends Parent implements CustomInterfaceName {}

/**
* TODO
* [TODO:description]
*
* @extends Parent
* @implements CustomInterfaceName
Expand Down
22 changes: 11 additions & 11 deletions test/filetypes/javascript/es6.vader
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Do (trigger doge):

Expect javascript (generated comment with @description @function tags):
/**
* TODO
* [TODO:description]
*
* @function
*/
Expand All @@ -30,7 +30,7 @@ Do (trigger doge):

Expect javascript (generated comment with @function and @param tags):
/**
* TODO
* [TODO:description]
*
* @function myFunc
* @param {[TODO:type]} $p1 [TODO:description]
Expand All @@ -41,7 +41,7 @@ Expect javascript (generated comment with @function and @param tags):
const myFunc = ($p1 = 'value', p2 = [], p3, p4) => {}

/**
* TODO
* [TODO:description]
*
* @function myFunc
* @param {[TODO:type]} $p1 [TODO:description]
Expand All @@ -62,7 +62,7 @@ Do (trigger doge):

Expect javascript (generated comment with @function, @param and @return tags):
/**
* TODO
* [TODO:description]
*
* @function myFunc
* @param {string} $p1 [TODO:description]
Expand Down Expand Up @@ -96,7 +96,7 @@ Do (trigger doge):
Expect javascript (generated comments with @function, @param and @return tags):
class Test {
/**
* TODO
* [TODO:description]
*
* @function myMethod
* @param {number} b [TODO:description]
Expand All @@ -106,7 +106,7 @@ Expect javascript (generated comments with @function, @param and @return tags):
}

/**
* TODO
* [TODO:description]
*
* @param {number} b [TODO:description]
* @return {number} [TODO:description]
Expand All @@ -133,7 +133,7 @@ Do (trigger doge):
Expect javascript (generated comment with @description and @param tags):
class Test {
/**
* TODO
* [TODO:description]
*
* @param {number} b [TODO:description]
*/
Expand All @@ -153,7 +153,7 @@ Do (trigger doge):

Expect javascript (generated comment with @function, @param and @return tags):
/**
* TODO
* [TODO:description]
*
* @function Person#greet
* @param {string} p1 [TODO:description]
Expand All @@ -173,7 +173,7 @@ Do (trigger doge):

Expect javascript (generated comment with @description and @function tags):
/**
* TODO
* [TODO:description]
*
* @function Person#greet
*/
Expand All @@ -190,7 +190,7 @@ Do (trigger doge):

Expect javascript (generated comment with @function, @param and @return tags):
/**
* TODO
* [TODO:description]
*
* @function myFunc
* @param {string} $p1 [TODO:description]
Expand All @@ -210,7 +210,7 @@ Do (trigger doge):

Expect javascript (generated comment with @function, @param and @return tags):
/**
* TODO
* [TODO:description]
*
* @async
* @function myFunc
Expand Down
22 changes: 11 additions & 11 deletions test/filetypes/javascript/functions.vader
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Do (trigger doge):

Expect javascript (generated comment with @description tag):
/**
* TODO
* [TODO:description]
*
*/
function myFunc(/* inline comment */) {}
Expand All @@ -25,7 +25,7 @@ Do (trigger doge):

Expect javascript (generated comment with @description and @param tags):
/**
* TODO
* [TODO:description]
*
* @param {[TODO:type]} $p1 [TODO:description]
* @param {[TODO:type]} p2 [TODO:description]
Expand All @@ -45,7 +45,7 @@ Do (trigger doge):

Expect javascript (generated comment with @param and @return tags):
/**
* TODO
* [TODO:description]
*
* @param {string} $p1 [TODO:description]
* @param {string[]} p2 [TODO:description]
Expand All @@ -66,7 +66,7 @@ Do (trigger doge):

Expect javascript (generated comment with @functon and @param tags):
/**
* TODO
* [TODO:description]
*
* @function myFunc
* @param {[TODO:type]} $p1 [TODO:description]
Expand All @@ -87,7 +87,7 @@ Do (trigger doge):

Expect javascript (generated comment with @function and @param tags):
/**
* TODO
* [TODO:description]
*
* @function myFunc
* @param {string} $p1 [TODO:description]
Expand Down Expand Up @@ -140,7 +140,7 @@ Do (trigger doge):

Expect javascript (generated comment with @function, @param and @return tags):
/**
* TODO
* [TODO:description]
*
* @function Person#greet
* @param {string} p1 [TODO:description]
Expand All @@ -160,7 +160,7 @@ Do (trigger doge):

Expect javascript (generated comment with @description and @function tags):
/**
* TODO
* [TODO:description]
*
* @function Person#greet
*/
Expand All @@ -177,7 +177,7 @@ Do (trigger doge):

Expect javascript (generated comment with @param and @return tags):
/**
* TODO
* [TODO:description]
*
* @param {string} $p1 [TODO:description]
* @param {Foo|Bar|Baz} p2 [TODO:description]
Expand All @@ -196,7 +196,7 @@ Do (trigger doge):

Expect javascript (generated comment with @async, and @param tags):
/**
* TODO
* [TODO:description]
*
* @async
* @param {[TODO:type]} $p1 [TODO:description]
Expand All @@ -217,7 +217,7 @@ Do (trigger doge):

Expect javascript (generated comment with @description and @param tags):
/**
* TODO
* [TODO:description]
*
* @param {[TODO:type]} $p1 [TODO:description]
* @param {[TODO:type]} p2 [TODO:description]
Expand All @@ -237,7 +237,7 @@ Do (trigger doge):

Expect javascript (generated comment with @async, and @param tags):
/**
* TODO
* [TODO:description]
*
* @async
* @param {[TODO:type]} $p1 [TODO:description]
Expand Down

0 comments on commit 304b104

Please sign in to comment.