extra-jsdoc-text - Utilities for processing JSDoc text

Utilities for processing JSDoc text.
📦 Node.js, 🌐 Web, 📜 Files, 📰 Docs.

This package is available in both Node.js and Web formats. The web format is exposed as extra_jsdoc_text standalone variable and can be loaded from jsDelivr CDN.

Stability: Experimental.

```javascript const jsdoc = require('extra-jsdoc-text');

function main() { var txt = /** * Parse jsdoc from jsdoc text. * @param txt jsdoc text * @returns parsed jsdoc */ , parse = null;

parse = jsdoc.parse(txt); // { // full: '\n' + // '/**\n' + // ' * Parse jsdoc from jsdoc text.\n' + // ' * @param txt jsdoc text\n' + // ' * @returns parsed jsdoc\n' + // ' */\n' + // ' ', // description: 'Parse jsdoc from jsdoc text.\n', // params: [ // { // full: '@param txt jsdoc text', // name: 'txt', // type: '', // description: 'jsdoc text' // } // ], // returns: { // full: '@returns parsed jsdoc', // type: '', // description: 'parsed jsdoc' // }, // examples: [] // }

parse.description += ' (only if simple)'; jsdoc.stringify(parse); // '/**\n' + // ' * Parse jsdoc from jsdoc text.\n' + // ' * (only if simple)\n' + // ' * @param txt jsdoc text\n' + // ' * @returns parsed jsdoc\n' + // ' * */\n' } main(); ```

Index

| Property | Description | | ---- | ---- | | parse | Parse jsdoc from jsdoc text. | | stringify | Stringify jsdoc text from parsed jsdoc. |

- JavaScript
Published by wolfram77 almost 4 years ago