Coder Social home page Coder Social logo

Strange parsing issue(?) about docma HOT 5 CLOSED

takase1121 avatar takase1121 commented on June 2, 2024
Strange parsing issue(?)

from docma.

Comments (5)

onury avatar onury commented on June 2, 2024

JSDoc does not care about the file structure. It's about class/namespace hierarchy.
Docma tree outline shows that the hierarchy is not correctly documented with JSDoc.

Make sure your parse() function is a child of DocLoader.
One way is this:

/**
 *  Some description...
 *  @name DocLoader.parse
 *  @function
 */
parse() { 
 // ...
}

or you could use @memberof
..

Pls consult JSDoc documentation.

from docma.

takase1121 avatar takase1121 commented on June 2, 2024

none of your suggestion worked. Here is a snippet of code I had.

export class DocLoader {
    /**
     * Parses a file
     * @param {string} filename The filename to parse
     */
    static async parse(filename) {
        ...
    }
}

I really can't find out where's the issue

from docma.

onury avatar onury commented on June 2, 2024

It seems you didn't document DocLoader.

from docma.

takase1121 avatar takase1121 commented on June 2, 2024

How do I do that?

from docma.

takase1121 avatar takase1121 commented on June 2, 2024

Thanks for your help. Apparently I just have to document the classes with @class tag now it works fine.

from docma.

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.