@ily1437/jsdoc

v1.8.9

Published

5 months ago

build jsdoc

Downloads

147

0High
0Medium
0Low

ily1437

jsdoc es6 doc javascript doc API doc

version log

how to use

npm install @ily1437/jsdoc
cd project_directory；suppose project_directory/src is source dir.

run node ./node_modules/@ily1437/jsdoc with:

v1.0.3+: .jsdocrc.js file in project root directory

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, ...
    }
}

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

v1.8.9 [2024-04-12]

fix bug for window

v1.8.8 [2024-04-12]

fix catch

v1.8.7 [2023-12-07]

fix bug for createClazz

v1.8.6 [2023-12-07]

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

v1.8.5 [2022-11-10]

update @param when type is defined with json structure
support type[]

v1.8.4 [2022-11-09]

update @see

v1.8.3 [2022-10-25]

fix a bug

v1.8.2 [2022-10-25]

change demo behavior

v1.8.1 [2022-10-24]

change demo behavior

v1.8.0 [2022-10-20]

optimize demoConfig

v1.7.11 [2022-10-14]

optimize code

v1.7.10 [2022-10-8]

fix a bug

v1.7.9 [2022-9-8]

fix a bug

v1.7.8 [2022-9-8]

add DemoConfig for jsdocrc

v1.7.7 [2022-9-8]

fix a bug for the api with @ignore keyword

v1.7.6 [2022-8-23]

optimize

v1.7.5 [2022-7-26]

enable doc content for ignoreClazz

v1.7.4 [2022-7-25]

fix copy patch files

v1.7.3 [2022-7-13]

fix for code

v1.7.2 [2022-7-6]

fix menu item selected

v1.7.1 [2022-6-27]

optimize code for indexContent

v1.7.0 [2022-6-20]

output date and version of package to files

v1.6.7 [2022-6-20]

Now all patchDir files are copied to output directory.

v1.6.6 [2022-6-17]

fix position of menu item selected

v1.6.5 [2022-6-17]

fix position of menu item selected

v1.6.4 [2022-6-17]

fix menu item selected

v1.6.3 [2022-6-15]

add quick-start nav

v1.6.2 [2022-6-15]

fix a bug.

v1.6.1 [2022-6-14]

change indexContent to a page slice.

v1.6.0 [2022-6-14]

update menu

v1.5.0 [2022-5-26]

support mdConfig:

when type is String, it is a path based on project root

when type is Array or JSON, it is config data.

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

v1.4.1 [2022-5-26]

move github-dark.css from js to config

v1.4.0 [2022-3-31]

support css/js patch for index & pages

v1.3.0 [2022-3-10]

fix for createClazz

v1.2.9 [2022-3-9]

fix a bug

v1.2.8 [2022-3-8]

fix a bug for readClazzInfo

v1.2.7 [2022-1-16]

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

v1.2.6 [2021-12-28]

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

v1.2.5 [2021-12-8]

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

v1.2.4 [2021-12-4]

support @ignoreClazz for class block comment and constructor comment

v1.2.3 [2021-11-20]

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

v1.1.0 [2021-11-8]

update highlight for code `

v1.0.3 [2021-9-29]

fix bug for index page menu: Class items

v1.0.2 [2021-8-22]

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

v1.0.1 [2021-8-10]