GithubHelp home page GithubHelp logo

Comments (3)

krampstudio avatar krampstudio commented on May 28, 2024

Please try to run the command produced in the debug. If the result is the same, this is an issue from jsdoc3 (it can be really capricious if something isn't well defined).

from grunt-jsdoc.

crfroehlich avatar crfroehlich commented on May 28, 2024

Running the jsdoc command produces the same output. It sounds like I'll have to keep digging.

[Update]

I did continue on to npm install jsdoc globally, so when I run jsdoc directly (as opposed to running from the grunt-jsdoc location ~node_modules\grunt-jsdoc\node_modules\jsdoc\jsdoc) with the --debug flag, I actually get the rhino debugger and can step through. It looks like the first problem is that jsdoc is looking for the 'plugins' folder at the root of my project (probably a red herring since it would normally look from the grunt-jsdoc relative path). Once removed, I can step through the entire execution without exception.

Further suggesting this is jsdoc's problem; but seems worth pointing out.

from grunt-jsdoc.

crfroehlich avatar crfroehlich commented on May 28, 2024

Ok. After some deep soul googling, I think I'm finally on the path to yes. After starting from @darlingjs blog post Creation of JavaScript Documentation, which is what launched my journey; I found @jewelsjacobs post Finally got JsDocs working with Node in which she ultimately opted to settle for the older jsdoc-toolkit. Unsatisfied, I finally found post How I introduced JsDoc by Simon Williams.

The key appears to be using

/**
* @memberOf jQuery
*/

After doing so in a single file, a few of my methods began appearing in the output. Then the remaining problems became much more obvious, most critically--when using Object.defineProperty, you have to specify the @name decorator. By whatever means JsDoc is parsing the AST, it is not associating property/method names with their corresponding objects; since this is the only way I add new properties/methods--I didn't get any documentation.

I think this is problem solved for me.

from grunt-jsdoc.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.