GithubHelp home page GithubHelp logo

Allow inline @property tags. about jsdoc HOT 2 CLOSED

jsdoc avatar jsdoc commented on May 12, 2024
Allow inline @property tags.

from jsdoc.

Comments (2)

micmath avatar micmath commented on May 12, 2024

I've implemented this work in a branch named 'inline_property_tags', and it has a test case like this:

/**
 * @namespace
 * @property {Object}  defaults   The default values.
 * @property {Number}  defaults.a The a property of the defaults.
 * @property {String}  defaults.b The b property of the defaults.
 */
myobject = {
    defaults: {
        a: 1,
        b: "Hit the light",
        /**
         *  The c property of the defaults.
         *  @member
         *  @type {Boolean}
         *  @property {String} prop The property of c.
         */
        c: true
    }
};

The syntax is like the @param tag. The example above demonstrates that the @property tag can no longer be used to mark the "kind" of thing a symbol is, that job is now handled by a new @member tag.

from jsdoc.

micmath avatar micmath commented on May 12, 2024

This feature was added in merge: a406e1c

from 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.