(js) Add support for class

This commit is contained in:
Daniel Mathiot
2021-08-25 15:49:26 +02:00
parent b57e833e32
commit 93797725e6
2 changed files with 19 additions and 2 deletions

View File

@@ -112,7 +112,7 @@ There is a list of supported languages and fields, with their annotation style
| | Google docstrings (`"google_docstrings"`) | `Args`, `Attributes`, `Returns` |
| | Numpydoc (`"numpydoc"`)| `Arguments`, `Attributes`, `Returns`|
| javascript | | |
| | JSDoc (`"jsdoc"`) | `@param`, `@returns` |
| | JSDoc (`"jsdoc"`) | `@param`, `@returns`, `@class`, `@classdesc` |
## Adding Languages

View File

@@ -14,8 +14,12 @@ local function_tree = {
},
},
}
return {
parent = { func = { "function_declaration", "expression_statement", "variable_declaration" }, },
parent = {
func = { "function_declaration", "expression_statement", "variable_declaration" },
class = { "function_declaration", "expression_statement", "variable_declaration", "class_declaration" },
},
data = {
func = {
@@ -48,6 +52,18 @@ return {
end,
},
},
},
class = {
["function_declaration|class_declaration|expression_statement|variable_declaration"] = {
["0"] = {
extract = function(_)
local results = {}
results.class_tag = { "" }
return results
end,
},
},
}
},
@@ -58,6 +74,7 @@ return {
jsdoc = {
{ nil, "/* */", { no_results = true } },
{ nil, "/**" },
{ "class_tag", " * @classdesc" , { before_first_item = { " * ", " * @class" } }},
{ "parameters", " * @param {any} %s " },
{ "return_statement", " * @returns {any} " },
{ nil, " */" },