Coder Social home page Coder Social logo

Comments (4)

levithomason avatar levithomason commented on April 28, 2024

If it is of any interest, there are some jsdoc parsers out in the wild that may save duplication of effort.

Eslint built doctrine for the valid-jsdoc and require-jsdoc rules. I tried the demo with the multiple example above and got:

{
    "description": "",
    "tags": [
        {
            "title": "example",
            "description": "Some instructions."
        },
        {
            "title": "example",
            "description": "Some other instructions."
        }
    ]
}

There are others as well, though in my estimation doctrine is the best and most maintained. Cheers!

from react-docgen.

fkling avatar fkling commented on April 28, 2024

Where/when are you using getDoclets? react-docgen itself doesn't actually try to parse the doclets because there are other tools out there that do a better job (as you noticed :) ).

I think getDoclets exists only for legacy reasons... you are free to use any other tool that exists if getDoclets doesn't work for you.

I don't see why react-docgen should depend on an external tool if it doesn't use it itself though...

from react-docgen.

levithomason avatar levithomason commented on April 28, 2024

When/where...

A gulp plugin.

I don't see why react-docgen should depend on an external tool...

I originally followed this comment on #5.

Thanks for clarifying the purpose of getDoclets. Hindsight from here is clear, I'll use something like doctrine instead.

from react-docgen.

fkling avatar fkling commented on April 28, 2024

Ah I see, fair enough :)

from react-docgen.

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.