Data-Foo Element in the dom
9 | * @example 10 | * [data-foo] { 11 | * background-color: red; 12 | * } 13 | * @throws {Error} if you give it something 14 | * @throws {TypeError} if you give it something else 15 | * @augments Foo 16 | * @augments Bar 17 | */ 18 | module.exports = function() { 19 | // this returns 1 20 | return 1; 21 | }; 22 | -------------------------------------------------------------------------------- /__tests__/fixture/auto_lang_hljs/multilanguage.output.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | ## multilanguage.input 4 | 5 | **Extends Foo, Bar** 6 | 7 | This function returns the number one. 8 | 9 | **Examples** 10 | 11 | ```js 12 | var myFoo = new Foo('[data-foo]'); 13 | myFoo.foo(42); 14 | ``` 15 | 16 | ```html 17 |Data-Foo Element in the dom
18 | ``` 19 | 20 | ```css 21 | [data-foo] { 22 | background-color: red; 23 | } 24 | ``` 25 | 26 | - Throws **[Error](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error)** if you give it something 27 | - Throws **[TypeError](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypeError)** if you give it something else 28 | 29 | Returns **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** numberone 30 | -------------------------------------------------------------------------------- /__tests__/fixture/bad/syntax.input: -------------------------------------------------------------------------------- 1 | * 2 | -------------------------------------------------------------------------------- /__tests__/fixture/bad/syntax.output.json: -------------------------------------------------------------------------------- 1 | { 2 | "pos": 19, 3 | "loc": { 4 | "line": 2, 5 | "column": 0 6 | }, 7 | "_babel": true 8 | } -------------------------------------------------------------------------------- /__tests__/fixture/boolean-literal-type.input.js: -------------------------------------------------------------------------------- 1 | /** */ 2 | function f(t: true, f: false): [true, false] { 3 | return [t, f]; 4 | } 5 | -------------------------------------------------------------------------------- /__tests__/fixture/class.input.js: -------------------------------------------------------------------------------- 1 | /** 2 | * This is my class, a demo thing. 3 | * @class MyClass 4 | * @implements {MyInterface} 5 | * @property {number} howMany how many things it contains 6 | */ 7 | function MyClass() { 8 | this.howMany = 2; 9 | } 10 | 11 | /** 12 | * Get the number 42 13 | * @param {boolean} getIt whether to get the number 14 | * @returns {number} forty-two 15 | */ 16 | MyClass.prototype.getFoo = function(getIt) { 17 | return getIt ? 42 : 0; 18 | }; 19 | 20 | /** 21 | * Get undefined 22 | * @returns {undefined} does not return anything. 23 | */ 24 | MyClass.prototype.getUndefined = function() {}; 25 | -------------------------------------------------------------------------------- /__tests__/fixture/config-bad.yml: -------------------------------------------------------------------------------- 1 | toc: 2 | - notfound 3 | -------------------------------------------------------------------------------- /__tests__/fixture/config-malformed.json: -------------------------------------------------------------------------------- 1 | * 2 | -------------------------------------------------------------------------------- /__tests__/fixture/config.json: -------------------------------------------------------------------------------- 1 | { 2 | "toc": ["bananas", "carrots", "apples"] 3 | } 4 | -------------------------------------------------------------------------------- /__tests__/fixture/custom_theme/index.js: -------------------------------------------------------------------------------- 1 | var File = require('vinyl'); 2 | 3 | /** 4 | * This is a theme only used by documentation to test custom theme 5 | * support. 6 | */ 7 | module.exports = function(comments, options, callback) { 8 | return Promise.resolve([ 9 | new File({ 10 | base: '/', 11 | path: '/index.html', 12 | contents: Buffer.from('Hello world') 13 | }) 14 | ]); 15 | }; 16 | -------------------------------------------------------------------------------- /__tests__/fixture/default-export-function.input.js: -------------------------------------------------------------------------------- 1 | /** i am foo */ 2 | export default function() { 3 | /** i am foo's son */ 4 | this.bar = () => {}; 5 | } 6 | -------------------------------------------------------------------------------- /__tests__/fixture/document-exported-bad/exports-z.js: -------------------------------------------------------------------------------- 1 | export var z = 1; 2 | -------------------------------------------------------------------------------- /__tests__/fixture/document-exported-bad/x.js: -------------------------------------------------------------------------------- 1 | export { y as x } from './exports-z.js'; 2 | -------------------------------------------------------------------------------- /__tests__/fixture/document-exported-export-default-object.input.js: -------------------------------------------------------------------------------- 1 | // Options: {"documentExported": true} 2 | 3 | export default { 4 | x: 42 5 | }; 6 | -------------------------------------------------------------------------------- /__tests__/fixture/document-exported-export-default-value.input.js: -------------------------------------------------------------------------------- 1 | // Options: {"documentExported": true} 2 | 3 | export default 42; 4 | -------------------------------------------------------------------------------- /__tests__/fixture/document-exported.input.js: -------------------------------------------------------------------------------- 1 | // Options: {"documentExported": true} 2 | 3 | export class Class { 4 | constructor(a: string) {} 5 | classMethod() {} 6 | get classGetter() {} 7 | set classSetter(v) {} 8 | static staticMethod() {} 9 | static get staticGetter() {} 10 | static set staticSetter(v) {} 11 | } 12 | 13 | export var object = { 14 | method() {}, 15 | get getter() {}, 16 | set setter(v) {}, 17 | prop: 42, 18 | func: function() {} 19 | }; 20 | 21 | /** Should not document this */ 22 | class NotExportedClass { 23 | /** Should not document this */ 24 | classMethod() {} 25 | /** Should not document this */ 26 | get classGetter() {} 27 | /** Should not document this */ 28 | set classSetter(v) {} 29 | /** Should not document this */ 30 | static staticMethod() {} 31 | /** Should not document this */ 32 | static get staticGetter() {} 33 | /** Should not document this */ 34 | static set staticSetter(v) {} 35 | } 36 | 37 | /** Should not document this */ 38 | var notExportedObject = { 39 | /** Should not document this */ 40 | method() {}, 41 | /** Should not document this */ 42 | get getter() {}, 43 | /** Should not document this */ 44 | set setter(v) {}, 45 | /** Should not document this */ 46 | prop: 42, 47 | /** Should not document this */ 48 | func: function() {} 49 | }; 50 | 51 | export { x, y3 as y4 } from './document-exported/x'; 52 | export z from './document-exported/z.js'; 53 | export y2Default from './document-exported/y.js'; 54 | 55 | function f1() {} 56 | function f2() {} 57 | 58 | export { f1, f2 as f3 }; 59 | 60 | export type T = number; 61 | type T2 = string; 62 | type T3 = string; 63 | 64 | export type { T2, T3 as T4 }; 65 | 66 | export type { T5 } from './document-exported/x.js'; 67 | 68 | export var f4 = function(x: X) {}; 69 | 70 | export { f5 }; 71 | 72 | export var o1 = { 73 | om1() {} 74 | }; 75 | 76 | /** f5 comment */ 77 | var f5 = function(y: Y) {}, 78 | o2 = { 79 | om2() {} 80 | }; 81 | export { o2 }; 82 | -------------------------------------------------------------------------------- /__tests__/fixture/document-exported/x.js: -------------------------------------------------------------------------------- 1 | export { y as x, y3 } from './y.js'; 2 | 3 | export type T5 = boolean; 4 | -------------------------------------------------------------------------------- /__tests__/fixture/document-exported/y.js: -------------------------------------------------------------------------------- 1 | export function y(yparam) {} 2 | 3 | function y2() {} 4 | 5 | export default y2; 6 | 7 | /** Description of y3 */ 8 | function y3(p: number): void {} 9 | 10 | export { y3 }; 11 | -------------------------------------------------------------------------------- /__tests__/fixture/document-exported/z.js: -------------------------------------------------------------------------------- 1 | export default class z { 2 | zMethod() {} 3 | } 4 | -------------------------------------------------------------------------------- /__tests__/fixture/es6-class-property.input.js: -------------------------------------------------------------------------------- 1 | /** 2 | * This is for issue 906. 3 | */ 4 | export class Issue906 { 5 | /** 6 | * This is a read-write property. 7 | * @type {boolean} 8 | */ 9 | get readWriteProp() { 10 | return this._rw; 11 | } 12 | 13 | set readWriteProp(value) { 14 | this._rw = value; 15 | } 16 | 17 | /** 18 | * This is a read-only property. 19 | * @type {string} 20 | * @readonly 21 | */ 22 | get readOnlyProp() { 23 | return 'foo'; 24 | } 25 | } 26 | -------------------------------------------------------------------------------- /__tests__/fixture/es6-class.input.js: -------------------------------------------------------------------------------- 1 | /** 2 | * This is my component. This is from issue #458 3 | */ 4 | class Foo extends React.Component {} 5 | 6 | /** 7 | * Does nothing. This is from issue #556 8 | * @param {string} str 9 | */ 10 | export class Bar { 11 | constructor(str) { 12 | /** 13 | * A useless property 14 | * @type {string} 15 | */ 16 | this.bar = ''; 17 | } 18 | } 19 | 20 | /** 21 | * This class has fully inferred constructor parameters. 22 | */ 23 | export class Baz { 24 | constructor(n: number, l: Array