Giter Site home page Giter Site logo

Comments (3)

jdalton avatar jdalton commented on August 25, 2024

+1, could you give an example of what the JSDoc comment block would look like.

from docdown.

abozhilov avatar abozhilov commented on August 25, 2024

I thought a little bit different strategy. Instead of linking every method I though about general examples file as:
https://gist.github.com/4163571
The body of the functions are the examples, which will be used in the documentation.

During the generation of the documentation there will be an option 'examples' => 'examples.js'.
This also give the ability of the user to easy load the examples.js and fire some examples.

What do you think about? This separation is not strong coupled and your code could be redistributed without or with different examples.

from docdown.

jdalton avatar jdalton commented on August 25, 2024

Closing as stale.

from docdown.

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.