allenhwkim / angular-jsdoc

AngularJS Template/Plugin for JSDoc 3.
MIT License
148 stars 57 forks source link

JSDoc files does not gets generated #95

Open hegdeashwin opened 8 years ago

hegdeashwin commented 8 years ago

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

randycasburn commented 8 years ago

+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 commented 8 years ago

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

reloaded commented 8 years ago

Agreed.