Comments (3)
+1, could you give an example of what the JSDoc comment block would look like.
from docdown.
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.
Closing as stale.
from docdown.
Related Issues (20)
- Port Docdown to JS from PHP [$115 awarded] HOT 12
- Lodash dependency version in JavaScript port HOT 1
- Object function toString() has no method 'push' in generator.js HOT 2
- Prep for npm publish. HOT 3
- Add support for the @since tag. HOT 7
- multiple API variants HOT 1
- Use doctrine to parse jsdoc HOT 10
- about docdown, i wrote a gulp plugin for it :) HOT 2
- param parse bug HOT 5
- Version number is not up to date HOT 1
- Support ES6/2015 class syntax HOT 2
- Issues with CR-LF line endings HOT 3
- error on empty tocgroup push
- Source link error/incompatibility with GitHub HOT 3
- Constructor entries break the parser
- Handle Namespaces
- TOC: Properties starting with "$" lead to duplicated link label HOT 3
- Issue with multi-line function descriptions HOT 6
- PHP 5.5 compatibility
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
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.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from docdown.