Comments (1)
It's actually possible to write comment directly in coffeescript it's ugly but it seems to work:
###*
* Escape the given `html`.
*
* Examples:
*
* utils.escape('<script></script>')
* // => '<script></script>'
*
* @param {String} html string to be escaped
* @return {String} escaped html
* @api public
###
exports.escape = (html) ->
return String(html)
.replace(/&(?!\w+;)/g, '&')
.replace(/</g, '<')
.replace(/>/g, '>')
will be compile in
/**
* Escape the given `html`.
*
* Examples:
*
* utils.escape('<script></script>')
* // => '<script></script>'
*
* @param {String} html string to be escaped
* @return {String} escaped html
* @api public
*/
exports.escape = function(html) {
return String(html).replace(/&(?!\w+;)/g, '&').replace(/</g, '<').replace(/>/g, '>');
};
Which is parsed in:
[
{
"tags": [
{
"type": "param",
"types": [
"String"
],
"name": "html",
"description": "string to be escaped"
},
{
"type": "return",
"types": [
"String"
],
"description": "escaped html"
},
{
"type": "api",
"visibility": "public"
}
],
"description": {
"full": "<p>Escape the given <code>html</code>.</p>\n\n<h2>Examples</h2>\n\n<pre><code>utils.escape('<script></script>')\n// => '&lt;script&gt;&lt;/script&gt;'\n</code></pre>",
"summary": "<p>Escape the given <code>html</code>.</p>",
"body": "<h2>Examples</h2>\n\n<pre><code>utils.escape('<script></script>')\n// => '&lt;script&gt;&lt;/script&gt;'\n</code></pre>"
},
"isPrivate": false,
"ignore": false,
"code": "exports.escape = function(html) {\n return String(html).replace(/&(?!\\w+;)/g, '&').replace(/</g, '<').replace(/>/g, '>');\n};",
"ctx": {
"type": "method",
"receiver": "exports",
"name": "escape",
"string": "exports.escape()"
}
}
]
Not sure it works in any situations...
from dox.
Related Issues (20)
- Class properties support HOT 1
- Extra whitespace when a tag is followed by an empty line HOT 5
- fileOverview/file/overview HOT 12
- Support more tags HOT 2
- Wrong parsing of param tags with line breaks
- Wrong parsing of default values
- Opt out of parsing typesDescription?
- `*` type ignored HOT 2
- Wrong parsing result when no type is given
- Override detected code with jsdoc directives? HOT 3
- [improvement] Handle @return description the same as @param description. HOT 2
- [improvement] better description handling, and theming idea HOT 6
- Handling ES-2015 exports
- Add support for ES2016 template literals HOT 2
- not parsing {@link} tag HOT 6
- Bump verision no HOT 4
- How to run this on any file (.cpp, .java, etc) HOT 1
- Parsing fails with no indication of which file is broken HOT 2
- Security vulnerabilities with jsdoctypeparser and lodash HOT 1
- dox does not support `async function` from ES2017 HOT 1
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 dox.