CARVIEW |
Select Language
HTTP/2 200
date: Wed, 23 Jul 2025 15:54:18 GMT
content-type: text/html; charset=utf-8
vary: X-PJAX, X-PJAX-Container, Turbo-Visit, Turbo-Frame, X-Requested-With,Accept-Encoding, Accept, X-Requested-With
x-robots-tag: none
etag: W/"1e33725bdbf9a3011cbd00aa47c6ce21"
cache-control: max-age=0, private, must-revalidate
strict-transport-security: max-age=31536000; includeSubdomains; preload
x-frame-options: deny
x-content-type-options: nosniff
x-xss-protection: 0
referrer-policy: no-referrer-when-downgrade
content-security-policy: default-src 'none'; base-uri 'self'; child-src github.githubassets.com github.com/assets-cdn/worker/ github.com/assets/ gist.github.com/assets-cdn/worker/; connect-src 'self' uploads.github.com www.githubstatus.com collector.github.com raw.githubusercontent.com api.github.com github-cloud.s3.amazonaws.com github-production-repository-file-5c1aeb.s3.amazonaws.com github-production-upload-manifest-file-7fdce7.s3.amazonaws.com github-production-user-asset-6210df.s3.amazonaws.com *.rel.tunnels.api.visualstudio.com wss://*.rel.tunnels.api.visualstudio.com objects-origin.githubusercontent.com copilot-proxy.githubusercontent.com proxy.individual.githubcopilot.com proxy.business.githubcopilot.com proxy.enterprise.githubcopilot.com *.actions.githubusercontent.com wss://*.actions.githubusercontent.com productionresultssa0.blob.core.windows.net/ productionresultssa1.blob.core.windows.net/ productionresultssa2.blob.core.windows.net/ productionresultssa3.blob.core.windows.net/ productionresultssa4.blob.core.windows.net/ productionresultssa5.blob.core.windows.net/ productionresultssa6.blob.core.windows.net/ productionresultssa7.blob.core.windows.net/ productionresultssa8.blob.core.windows.net/ productionresultssa9.blob.core.windows.net/ productionresultssa10.blob.core.windows.net/ productionresultssa11.blob.core.windows.net/ productionresultssa12.blob.core.windows.net/ productionresultssa13.blob.core.windows.net/ productionresultssa14.blob.core.windows.net/ productionresultssa15.blob.core.windows.net/ productionresultssa16.blob.core.windows.net/ productionresultssa17.blob.core.windows.net/ productionresultssa18.blob.core.windows.net/ productionresultssa19.blob.core.windows.net/ github-production-repository-image-32fea6.s3.amazonaws.com github-production-release-asset-2e65be.s3.amazonaws.com insights.github.com wss://alive.github.com api.githubcopilot.com api.individual.githubcopilot.com api.business.githubcopilot.com api.enterprise.githubcopilot.com; font-src github.githubassets.com; form-action 'self' github.com gist.github.com copilot-workspace.githubnext.com objects-origin.githubusercontent.com; frame-ancestors 'none'; frame-src viewscreen.githubusercontent.com notebooks.githubusercontent.com; img-src 'self' data: blob: github.githubassets.com media.githubusercontent.com camo.githubusercontent.com identicons.github.com avatars.githubusercontent.com private-avatars.githubusercontent.com github-cloud.s3.amazonaws.com objects.githubusercontent.com release-assets.githubusercontent.com secured-user-images.githubusercontent.com/ user-images.githubusercontent.com/ private-user-images.githubusercontent.com opengraph.githubassets.com copilotprodattachments.blob.core.windows.net/github-production-copilot-attachments/ github-production-user-asset-6210df.s3.amazonaws.com customer-stories-feed.github.com spotlights-feed.github.com objects-origin.githubusercontent.com *.githubusercontent.com; manifest-src 'self'; media-src github.com user-images.githubusercontent.com/ secured-user-images.githubusercontent.com/ private-user-images.githubusercontent.com github-production-user-asset-6210df.s3.amazonaws.com gist.github.com; script-src github.githubassets.com; style-src 'unsafe-inline' github.githubassets.com; upgrade-insecure-requests; worker-src github.githubassets.com github.com/assets-cdn/worker/ github.com/assets/ gist.github.com/assets-cdn/worker/
server: github.com
content-encoding: gzip
accept-ranges: bytes
set-cookie: _gh_sess=vndrzx9wsraSbxh6BlgGTkyX78tgesLJewnNlgnhfqUVt6Yhhl%2BTu9CUo2sFTk8efz%2BB6%2FjEcIpYuq%2FJj041uA1QTdYC9dewWPJEnB1twGGGEQK1nmQ1SOB1LG91RP1CmKwNx%2Feb1NscKUzPw1N%2Fxr9TaEvJOub1kcGDWDELzmHtGdfWoTzl5pWV3xzxGsPX%2B7I8PeEqk2Lp72lohHQ2DNt3nXwEwXpoZPWgftzjf69TvYr0Yb4q1X%2FBtHvBuQ5kvQXSR39If7nW8tU3YvB1XQ%3D%3D--dVrleIn9ZC%2FN%2FlF3--S9hwosO1SQIZedaQfZgehA%3D%3D; Path=/; HttpOnly; Secure; SameSite=Lax
set-cookie: _octo=GH1.1.1326113141.1753286058; Path=/; Domain=github.com; Expires=Thu, 23 Jul 2026 15:54:18 GMT; Secure; SameSite=Lax
set-cookie: logged_in=no; Path=/; Domain=github.com; Expires=Thu, 23 Jul 2026 15:54:18 GMT; HttpOnly; Secure; SameSite=Lax
x-github-request-id: EAD2:121670:E4910F:10E0405:688105AA
Exemplary APIs · jsdoc2md/jsdoc-to-markdown Wiki · GitHub
Skip to content
Navigation Menu
{{ message }}
-
Notifications
You must be signed in to change notification settings - Fork 151
Exemplary APIs
Aral Balkan edited this page Mar 23, 2020
·
9 revisions
Links to generated examples.
These examples all generate custom README files, passing a handlebars template to --template
.
Project | Notes |
---|---|
handbrake-js |
A module exposing two methods and an inner class. Demonstrates documenting events, linked types and use of |
command-line-args | Demonstrates documentation of a @module exporting a ES2015 class, the @typicalname , @throws and @alias tags. |
array-tools | Very simple module exporting a collection of static methods. Demonstrates use of @example and @category to group identifiers in the member-list. |
jesucarr/tokenbucket | Demonstrates --param-list-format list and the documentation of Promises using the @fulfil and @reject tags. |
ansi-escape-sequences | Demonstrates usage of @enum {type} (rendered in table format). |
Feel free to send me a link to your docs.
- EmergingTechnologyAdvisors/node-serialport
- apache/cordova-plugin-camera (customised)
- Polymer/polymer-analyzer
- Google/eddystone
- websockets/ws
- wikimedia/node-rdkafka
- noodlefrenzy/node-amqp10 (massive, tables, ascii diagrams)
- IBM-Bluemix/gp-js-client
- alexmingoia/koa-router
- IjzerenHein/famous-map
- devicehive/devicehive-javascript
- dc-js/dc.js (massive)
-
alexindigo/multibundle-mapper (use of
--private
) -
AndyOGo/gulp-pilot (uses
@example
captions and custom tags)
- Home
- How jsdoc2md works
- Additional jsdoc tags supported
- Cherry picking which documentation appears in output
- Showcase ...
- Create ...
- How To ...
- How to use with npm run
- How to use with gulp
- How to create one output file per class
- How to document a AMD module
- How to document a CommonJS module (exports)
- How to document a CommonJS module (module.exports)
- How to document an ES2015 module (multiple named exports)
- How to document an ES2015 module (single default export)
- How to document Promises (using custom tags)
- How to document a ToDo list
- How to document ES2017 features
- How to document TypeScript
- The @typicalname tag
- Linking to external resources
- Param list format options
- Listing namepaths
- Troubleshooting
Clone this wiki locally
You can’t perform that action at this time.