Unable to JSDoc directory under Windows

231 views
Skip to first unread message

thech701storm

unread,
Jun 11, 2014, 11:15:39 AM6/11/14
to jsdoc...@googlegroups.com

Good day, 
I installed JSdoc322 into C:\Progs\jsdoc-322\ with the default template. I also modified the conf.json file to include my complete JavaScript library (recurse = true or -r ). 
My issues are :

  • JSdoc only pickup the first script from the library and stops there - does not do the entire directory. 
  • I'm using the command line and the conj.json with NO better result
  • I tried sticking the JS library in the INCLUDE portion of conf.json but it does not get picked up and trying to name each JS file neither. I suspect the template is not handling Windows paths properly.
  • I tried putting back the linenumbers when displaying the source code but it does not work or I dont have enough info for it to work properly.
  • I want to run JSDoc as a standalone app - DO I need to install it with NPM and what does NPM do ?
  • I saw that JSDoc322 uses TAFFYDB, why ? Do I need it ? How do I install it and hook it in ?
conf.json

{
    "tags": {
        "allowUnknownTags": true
    },
    "source": {
   "include": [ "c:/Temp/ScriptLibrary/" ],
        "includePattern": ".+\\.js(doc)?$",
        "excludePattern": "(^|\\/|\\\\)_"
    },
    "plugins": [
     "],
    "templates": {
        "cleverLinks": false,
        "monospaceLinks": false,
        "default": {
            "outputSourceFiles": true
        }
    },
"opts": {                                                                   
    "recurse": true

    } 
}

can someone give me pointers on how to make this work. I had version 2 and everything worked great but tags were limited..


Thanks
Norm

Jeff Williams

unread,
Jun 30, 2014, 12:03:12 PM6/30/14
to thech701storm, JSDoc Users
Hi Norm:

On Wed, Jun 11, 2014 at 8:15 AM, thech701storm <thech7...@hotmail.com> wrote:

Good day, 
I installed JSdoc322 into C:\Progs\jsdoc-322\ with the default template. I also modified the conf.json file to include my complete JavaScript library (recurse = true or -r ). 
My issues are :

  • JSdoc only pickup the first script from the library and stops there - does not do the entire directory. 
  • I'm using the command line and the conj.json with NO better result
What happens if you delete your conf.json file, then run the following command?

jsdoc.cmd c:\Temp\ScriptLibrary -r  
  • I tried sticking the JS library in the INCLUDE portion of conf.json but it does not get picked up and trying to name each JS file neither. I suspect the template is not handling Windows paths properly.
This is unlikely to be a template issue. The template doesn't do anything until JSDoc has finished parsing all of your JavaScript source files.

For JSDoc 3.2.2, follow these steps to see which files JSDoc is trying to parse:
  1. In the JSDoc directory, copy conf.json.EXAMPLE to conf.json.
  2. Open conf.json in a text editor, and find the following line:

    "plugins": [],

  3. Replace that line with the following:

    "plugins": ["plugins/verboseOutput"],

  4. Save and close conf.json.
  5. Run JSDoc. For each source file, JSDoc prints the name of the source file to the console.
For JSDoc 3.3.0 (which is still in alpha), simply use the --verbose switch when you run JSDoc. This will also print each file name to the console, along with some other useful info.
  • I tried putting back the linenumbers when displaying the source code but it does not work or I dont have enough info for it to work properly.
In JSDoc 3.2.2, the default template did not show line numbers for source files. This feature has been added for JSDoc 3.3.0.

I'll be releasing JSDoc 3.2.3 very soon to pick up a couple of important bugfixes. Before I release 3.2.3, I'll backport the line-numbering feature.
  • I want to run JSDoc as a standalone app - DO I need to install it with NPM and what does NPM do ?
For JSDoc 3.2.x, installing with npm (the Node.js package manager) is totally optional. If you install with "npm -g", you should be able to run the "jsdoc" command from any directory. You can also just clone the git repo and add the JSDoc directory to your PATH.
  • I saw that JSDoc322 uses TAFFYDB, why ? Do I need it ? How do I install it and hook it in ?
TaffyDB is just a JavaScript module that provides an in-memory database. It comes with JSDoc. No need to install anything extra.

- Jeff

Reply all
Reply to author
Forward
0 new messages