Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Double entries #138

Closed
kelylah opened this issue Jun 10, 2015 · 4 comments
Closed

Double entries #138

kelylah opened this issue Jun 10, 2015 · 4 comments

Comments

@kelylah
Copy link

kelylah commented Jun 10, 2015

When I'm generating documentation using grunt plugin I get double entries like this:
image

When I'm using clearly jsdoc than every thing is ok.

My configuration

jsdoc: {
            dist: {
                src: ['./**/*.js', '!./**/strings.js', '!./**/setting/*', '!./general-doc/site/**/*', '!./node_modules/**/*', '!./api-doc/**/*', '!./dev-doc/**/*'],
                dest: './api-doc/',
                options: {
                    configure: './jsdoc_config.json'
                }
            }
        }

and jsdoc_config.json

{
    "tags": {
        "allowUnknownTags": true
    },
    "source": {
                "include": ["./", "./README.md"],
                "exclude": ["api-doc", "general_doc", "node_modules"],
        "includePattern": ".+\\.js(doc)?$",
        "excludePattern": "(^|\\/|\\\\)\\.|strings.js"
    },
    "plugins": [],
    "templates": {
        "cleverLinks": false,
        "monospaceLinks": false,
        "default": {
            "outputSourceFiles": false
        },
                "navType": "vertical",
                "linenums": true,
                "collapseSymbols": true,
                "copyright": ".:EPL DEV TEAM:. (C)Esri Polska 2015",
                "systemName": "WAB Widgets",
                "theme": "spacelab"
    },
        "opts": {
            "template": "./node_modules/ink-docstrap/template",
            "encoding": "utf8",             
            "destination": "./api-doc/",    
            "recurse": true,                
            "private": true
        }
}
@krampstudio
Copy link
Owner

Isn't it because the source of the config file and the src propery of the grunt plugin add the same file 2 times ?

@kelylah
Copy link
Author

kelylah commented Jun 10, 2015

Hi thanks for answer.

When I removed include from jsdoc_config.json than it helps.Unfortunately I can't remove it from grunt task because I get warning:

Running "jsdoc:dist" (jsdoc) task
Warning: Cannot call method 'indexOf' of undefined Use --force to continue.

Aborted due to warnings.

It isn't comfortable to make changes in config depending you want grunt task or normal jsdoc generation.
I've prepared two files with jsdoc configuration and that is good enought walkaround.

@krampstudio
Copy link
Owner

Yes, right now the src property is required, but I'm planned to make it optional if there's a jsdoc config file see #87

@kelylah
Copy link
Author

kelylah commented Jun 10, 2015

It would be great. Right now I'll use this 2 config files.
Above issue I've read before I wrote to you (Google my friend).

Thanks once again.

@kelylah kelylah closed this as completed Jun 10, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants