Comments (3)
node-sodium is a great idea.
jsdox is not quite smart enough to figure out Hash.hash is a function, but you can provide some hints like so:
/**
* Hash functions
* @module Hash
*/
module.exports.Hash = {
/**
* @function hash
* Default message hash
*/
hash: binding.crypto_hash,
/**
* @function sha256
* SHA 256
*/
sha256: binding.crypto_hash_sha256,
/**
* @function sha512
* SHA 512
*/
sha512: binding.crypto_hash_sha512,
/** Size of hash buffer in bytes */
bytes: binding.crypto_hash_BYTES,
/** Size of hash block */
blockBytes: binding.crypto_hash_BLOCKBYTES,
/** Default primitive */
primitive: binding.crypto_hash_PRIMITIVE
};
there would be the @constant
tag for things like bytes
, blockBytes
, primitive
, but this is not yet implemented.
from jsdox.
I don't even think JSDoc knows what to do with the docblocks in that file. Can we maybe close this issue?
from jsdox.
closing as we haven't heard back.
from jsdox.
Related Issues (20)
- Broken tags view
- Config flag confusing
- Replace -rr with just -r? HOT 7
- Should we deprecate the use of a config file? HOT 3
- Use cases for jsdox? HOT 6
- Support of @example HOT 4
- Generate table of contents HOT 3
- Fails on --rr with empty grandparent folder. HOT 1
- How to get parameters of Class Constructor HOT 2
- Enable Sourcegraph HOT 1
- Param descriptions show function description of no param description was defined
- @copyright, @license, etc. do not show unless @overview is defined
- How to document object params with particular properties HOT 1
- Can you suppress the Global title at the top of the page? HOT 3
- Jsdox doesn't handle optional parameters HOT 4
- Error: Unexpected end of input HOT 4
- ECMA6 Support HOT 1
- Generated paths do not work when generated content is pushed to Git.
- Recursive command doesn't ignore non-JS files
- NPM Mustache vulnerability
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 jsdox.