No More Posting New Topics!

If you have a question or an issue, please start a thread in our Github Discussions Forum.
This forum is closed for new threads/ topics.

Navigation

    Quasar Framework

    • Login
    • Search
    • Categories
    • Recent
    • Tags
    • Popular
    • Users
    • Groups
    • Search

    Recommendation for generating documentation?

    Help
    2
    3
    461
    Loading More Posts
    • Oldest to Newest
    • Newest to Oldest
    • Most Votes
    Reply
    • Reply as topic
    Log in to reply
    This topic has been deleted. Only users with topic management privileges can see it.
    • R
      rconstantine last edited by

      I’ve used documentation generators ages ago, and my team would like to generate documentation for our Quasar projects. The only thing I’ve come across that looks like it might work is jsdoc plus the vue plugin. But it doesn’t seem like that alone will work with Quasar due to the unique structure and features added.

      Do you guys have any recommendations? If you’ve used jsdoc, do you know how we could get it to properly document Quasar stuff?

      1 Reply Last reply Reply Quote 1
      • nothingismagick
        nothingismagick last edited by

        I have used JSDoc, and its good. Document your functions like any other JS. Some people might tell you to use typescript, as it is “self-documenting”, but I still think that having a JSDoc type reference is good thing.

        1 Reply Last reply Reply Quote 0
        • R
          rconstantine last edited by

          Looking into that. Thanks.

          1 Reply Last reply Reply Quote 0
          • First post
            Last post