Skip to content
This repository has been archived by the owner on May 30, 2020. It is now read-only.

JSDoc files does not gets generated #95

Open
hegdeashwin opened this issue Jul 12, 2016 · 3 comments
Open

JSDoc files does not gets generated #95

hegdeashwin opened this issue Jul 12, 2016 · 3 comments

Comments

@hegdeashwin
Copy link

I am using Node.js v4.2.5 and npm v2.14.12, jsdoc v3.4.0 and angular-jsdoc v1.4.2

Below is my package.json file

{
  "name": "abc",
  "version": "0.0.1",
  "scripts": {
    "jsdoc": "./node_modules/.bin/jsdoc --configure ./node_modules/angular-jsdoc/common/conf.json --template ./node_modules/angular-jsdoc/angular-template --destination docs --recurse ./src"
  },
  "dependencies": {
    "angular": "~1.5.7"
  },
  "devDependencies": {
    "angular-jsdoc": "~1.4.2",
    "jsdoc": "~3.4.0"
  }
}

When I try to execute npm run jsdoc below things happen:

  1. Console returns no error or warning
  2. Default directories like css, js, source, templates, tutorials are created with empty.

I have specified jsdoc comments E.g.

/**
 * @summary List of stylesheets which need to be injected first
 */

but nothing happens

@hegdeashwin hegdeashwin changed the title Files does not gets generated JSDoc files does not gets generated Jul 12, 2016
@randycasburn
Copy link

randycasburn commented Jul 15, 2016

+1 - This simply requires a documentation update:

Please clarify that the index.html file will NOT be generated in the destination folder if you include an empty README.

This was my situation and has been resolved for me. Please consider updating the docs.

@schmod
Copy link
Collaborator

schmod commented Jul 15, 2016

This really sounds like a bug -- we should tolerate an empty README.

@reloaded
Copy link
Contributor

Agreed.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants