Code Monkey home page Code Monkey logo

Comments (8)

tmcw avatar tmcw commented on July 17, 2024

Retitled to something actionable; appreciate the attempt at humor (sarcasm?) but to stay sane and productive we should focus on actionable issues.

Does jsdoc provide correct output? Can you provide an example of the code you're documenting so that we can determine where the issue lies?

from gulp-documentation.

blaasvaer avatar blaasvaer commented on July 17, 2024

This is one small module:

/**
 * This is the entry point for the admin interface
 * 
 * @namespace Index
 * @param  {String}
 * @return {Object} Exports object
 */
var Index = (function () {
    var _name = 'Project name';

    /**
     * Initialize application
     * @memberOf Index
     * @return {void}
     */
    function init () {
        var dashboard = require('dashboard');

        // Set initial Document Title to the name of the app
        document.title = _name;

        addEventListeners();
    }

    /**
     * This is left blank intentionally
     * @memberOf Index
     */
    function addEventListeners () {}

    /**
     * Initialize module Index internally
     */
    init();
}());

module.exports = Index;

All other modules are based on the same syntax.

from gulp-documentation.

blaasvaer avatar blaasvaer commented on July 17, 2024

It outputs a directory called 'assets' and an index.html file. In the assets directory I find these files:

anchor.js
bass.css
github.css
site.js
style.css

If that is what it's supposed to output then I guess it does provide correct output.

from gulp-documentation.

tmcw avatar tmcw commented on July 17, 2024

Can you try changing @memberOf Index to @memberof Index? The memberof tag, like all other JSDoc tags, is all lowercase.

from gulp-documentation.

blaasvaer avatar blaasvaer commented on July 17, 2024

OK, that made something of a difference. Am I wrong if I think that it used to be with a capital O?

Well, I guess I'll walk over all the syntax again ... thanks for pointing that out.

from gulp-documentation.

tmcw avatar tmcw commented on July 17, 2024

I don't believe so, in 2012, before the site moved to usejsdoc.org, it was all lowercase commit

from gulp-documentation.

blaasvaer avatar blaasvaer commented on July 17, 2024

Yeah, but I'm using DocBlockr in Sublime Text 2 / 3 and there it is @memberof. Even google code has it referenced with an uppercase o:
https://code.google.com/archive/p/jsdoc-toolkit/wikis/TagReference.wiki

Don't know what's going on. It used to work fine with the original gulp-jsdoc with an upper o. I've opened a ticket, asking them to change it to a lower case. We'll see if that will happen. In ST 2 I can change the bugger myself. But due to the change in how packages are managed in ST 3 I can do nothing but wait for 'someone' to do 'something'. That's one of the cons of depending on other peoples code ... I guess it wouldn't make any sense for you to go .toLowerCase() on all @NAMEs in gulp-documentation?

from gulp-documentation.

blaasvaer avatar blaasvaer commented on July 17, 2024

SOLUTION FOUND: In case any other poor soul is looking for a solution to this:
Install PackageResourceViewer for ST3, and voila, edit the resource yourself.

https://github.com/skuroda/PackageResourceViewer

from gulp-documentation.

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.