npm package: @ily1437/jsdoc
Description: build jsdoc
Author: flow
Latest version: 1.8.9

# version log

## how to use

1. npm install `@ily1437/jsdoc`
2. cd `project_directory`；suppose `project_directory/src` is source dir.
3. run `node ./node_modules/@ily1437/jsdoc` with:
    1. v1.0.3+: `.jsdocrc.js` file in project root directory

        ```javascript
        module.exports = {
            dir: './src',
            // docErrorDir: `dist/docErrorFiles/`,
            docOutputDir: `dist/docFiles/pages`,    //optional
            debug: false,
            index: 'indexContent.html',
            mdConfig: 'mdConfig.json',  //since 1.5.0
            pageConfig: {   //since 1.4.0
                css: ['../page_patch.css'],
                js: []
            },
            indexConfig: {   //since 1.4.0
                css: ['index_patch.css'],
                js: []
            },
            demoConfig: {   //since 1.7.8
                text: 'Demos',
                url: '../demo.html',
                inputDir: './inputDirName', //since 1.8.0
                outputDir: './outputDirName',   //since 1.8.0
            },
            patchDir: './docPatch',   //since 1.4.0
            keywordsDic: {  //since v1.2.3
                Enum: true, ...
            }
        }
        ```

    2. v1.0.2-: cmd params: `./src [enableDebug] [indexContentFilePath]`

____________

## v1.8.9 [2024-04-12]

1. fix bug for window

____________

## v1.8.8 [2024-04-12]

1. fix catch

____________

## v1.8.7 [2023-12-07]

1. fix bug for createClazz

____________

## v1.8.6 [2023-12-07]

1. support: when read `index.js`, use its `<dirname>.js` as doc file target
2. fix tip: `Cannot read properties of undefined (reading 'name')`

____________

## v1.8.5 [2022-11-10]

1. update `@param` when type is defined with json structure
2. support `type[]`

____________

## v1.8.4 [2022-11-09]

1. update `@see`

____________

## v1.8.3 [2022-10-25]

1. fix a bug

____________

## v1.8.2 [2022-10-25]

1. change demo behavior

____________

## v1.8.1 [2022-10-24]

1. change demo behavior

____________

## v1.8.0 [2022-10-20]

1. optimize `demoConfig`

____________

## v1.7.11 [2022-10-14]

1. optimize code

____________

## v1.7.10 [2022-10-8]

1. fix a bug

____________

## v1.7.9 [2022-9-8]

1. fix a bug

____________

## v1.7.8 [2022-9-8]

1. add DemoConfig for jsdocrc

____________

## v1.7.7 [2022-9-8]

1. fix a bug for the api with `@ignore` keyword

____________

## v1.7.6 [2022-8-23]

1. optimize

____________

## v1.7.5 [2022-7-26]

1. enable doc content for ignoreClazz

____________

## v1.7.4 [2022-7-25]

1. fix copy patch files

____________

## v1.7.3 [2022-7-13]

1. fix for code

____________

## v1.7.2 [2022-7-6]

1. fix menu item selected

____________

## v1.7.1 [2022-6-27]

1. optimize code for indexContent

____________

## v1.7.0 [2022-6-20]

1. output date and version of package to files

____________

## v1.6.7 [2022-6-20]

1. Now all patchDir files are copied to output directory.

____________

## v1.6.6 [2022-6-17]

1. fix position of menu item selected

____________

## v1.6.5 [2022-6-17]

1. fix position of menu item selected

____________

## v1.6.4 [2022-6-17]

1. fix menu item selected

____________

## v1.6.3 [2022-6-15]

1. add quick-start nav

____________

## v1.6.2 [2022-6-15]

1. fix a bug.

____________

## v1.6.1 [2022-6-14]

1. change indexContent to a page slice.

____________

## v1.6.0 [2022-6-14]

1. update menu

____________

## v1.5.0 [2022-5-26]

1. support mdConfig:
    1. when type is `String`, it is a path based on project root
    2. when type is `Array` or `JSON`, it is config data.

        ```json
        [
            {
                "md": "readme.MD",
                "filename": "doc/md/readme.html",
                "template": "template/template.html"
            }
        ]
        ```

____________

## v1.4.1 [2022-5-26]

1. move `github-dark.css` from js to config

____________

## v1.4.0 [2022-3-31]

1. support css/js `patch` for `index & pages`

____________

## v1.3.0 [2022-3-10]

1. fix for createClazz

____________

## v1.2.9 [2022-3-9]

1. fix a bug

____________

## v1.2.8 [2022-3-8]

1. fix a bug for readClazzInfo

____________

## v1.2.7 [2022-1-16]

1. fix a bug for the member of class which is filled with a variant in class file scope;

____________

## v1.2.6 [2021-12-28]

1. fix a bug for `createClazz`, when it is a `variant declaration`;

____________

## v1.2.5 [2021-12-8]

1. support `@see {A.B#c}`
2. support multi-line comments

____________

## v1.2.4 [2021-12-4]

1. support `@ignoreClazz` for class block comment and constructor comment

____________

## v1.2.3 [2021-11-20]

1. add `keywordDic` for `.jsdocrc.js`, you can highlight more keywords for api in jsdoc

____________

## v1.1.0 [2021-11-8]

1. update highlight for code
        `

____________

## v1.0.3 [2021-9-29]

1. fix bug for index page menu: Class items

____________

## v1.0.2 [2021-8-22]

1. 支持export 值为 createClazz, 它的return值会作为Class来解析

____________

## v1.0.1 [2021-8-10]

build jsdoc

1. 支持动态class的js doc生成
2. 支持es
    1. static public attribute: static get prop = v;
    2. static public attribute: static get prop(){}
    3. static public member: static method(){}
    4. public attribute: get prop(){}
    5. public member: prop = v;
    6. public method: method(){}
3. 支持@memberof / @see / @example / @params / @returns
    1. 支持关键字highlight
4. 支持method的comments与内部变量关联时的引用
5. 支持class的constructor备注与class备注的合一，优先使用constructor的备注
6. 支持自定义首页