Documentation
¶
Overview ¶
Copyright © 2025 Benny Powers
This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.
Index ¶
- func EnrichCSSPropertyWithJSDoc(jsdocText string, prop *M.CssCustomProperty, queryManager *Q.QueryManager) error
- func EnrichClassWithJSDoc(jsdocText string, decl *M.ClassDeclaration, queryManager *Q.QueryManager) error
- func EnrichCustomElementWithJSDoc(jsdocText string, decl *M.CustomElementDeclaration, ...) error
- func EnrichFunctionWithJSDoc(jsdocText string, fn *M.FunctionDeclaration, queryManager *Q.QueryManager) error
- func EnrichMethodWithJSDoc(jsdocText string, method *M.ClassMethod, queryManager *Q.QueryManager) error
- func EnrichPropertyWithJSDoc(jsdocText string, prop *M.PropertyLike, queryManager *Q.QueryManager) error
- func ExtractAliasFromJSDoc(jsdocText string, queryManager *Q.QueryManager) (string, error)
- func ExtractFromNode(node *ts.Node, source []byte) string
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func EnrichCSSPropertyWithJSDoc ¶
func EnrichCSSPropertyWithJSDoc(jsdocText string, prop *M.CssCustomProperty, queryManager *Q.QueryManager) error
EnrichCSSPropertyWithJSDoc parses JSDoc comment text and applies the extracted information to a CssCustomProperty.
func EnrichClassWithJSDoc ¶
func EnrichClassWithJSDoc(jsdocText string, decl *M.ClassDeclaration, queryManager *Q.QueryManager) error
EnrichClassWithJSDoc parses JSDoc comment text and applies the extracted information to a ClassDeclaration.
func EnrichCustomElementWithJSDoc ¶
func EnrichCustomElementWithJSDoc(jsdocText string, decl *M.CustomElementDeclaration, queryManager *Q.QueryManager) error
EnrichCustomElementWithJSDoc parses JSDoc comment text and applies the extracted information to a CustomElementDeclaration.
func EnrichFunctionWithJSDoc ¶
func EnrichFunctionWithJSDoc(jsdocText string, fn *M.FunctionDeclaration, queryManager *Q.QueryManager) error
EnrichFunctionWithJSDoc parses JSDoc comment text and applies the extracted information to a FunctionDeclaration.
func EnrichMethodWithJSDoc ¶
func EnrichMethodWithJSDoc(jsdocText string, method *M.ClassMethod, queryManager *Q.QueryManager) error
EnrichMethodWithJSDoc parses JSDoc comment text and applies the extracted information to a ClassMethod.
func EnrichPropertyWithJSDoc ¶
func EnrichPropertyWithJSDoc(jsdocText string, prop *M.PropertyLike, queryManager *Q.QueryManager) error
EnrichPropertyWithJSDoc parses JSDoc comment text and applies the extracted information to a PropertyLike.
func ExtractAliasFromJSDoc ¶
func ExtractAliasFromJSDoc(jsdocText string, queryManager *Q.QueryManager) (string, error)
ExtractAliasFromJSDoc parses JSDoc comment text and returns the @alias value if present.
Types ¶
This section is empty.
Source Files