You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Hello,
I am not able to create documentation for the React render method if it contains a JSX comment.
=== JSX comment example ===
{/* Test Coment */}
Is there any configuration by which I can ignore these comments and generate comments for the render method?
=== Render method example ===
/**
* render is a react lifecycle method.
* @access private
* @return {ReactElement} HTML
*/
render () {
let _this = this;
return (
<div>
{/* Test Coment */}
</div>
)
}
=== ESDOC json config file ===
{
"source": "..",
"destination": "docs",
"includes": ["\\.(js|jsx)$"],
"plugins": [
{
"name": "esdoc-standard-plugin",
"option": {
"lint": {"enable": false},
"coverage": {"enable": true},
"accessor": {
"access": ["public", "protected"],
"autoPrivate" : false
},
"undocumentIdentifier" : {"enable": false},
"typeInference": {"enable": true},
}
},
{
"name": "esdoc-jsx-plugin",
"option": {"enable": true}
},
{
"name": "esdoc-react-plugin",
"option": {"enable": true}
},
{
"name": "esdoc-lint-plugin",
"option": {"enable": true}
}
]
}
The text was updated successfully, but these errors were encountered:
karanbajaj2209
changed the title
ESDoc able to document if render method has JSX comment
ESDoc not able to generate documentation if render method has a JSX comment
Oct 11, 2017
The text was updated successfully, but these errors were encountered: