From eb3aa051da9df81086c7adba0d03e404b754b025 Mon Sep 17 00:00:00 2001
From: Paul Duncan <pabs@pablotron.org>
Date: Sun, 9 Sep 2018 21:47:08 -0400
Subject: js: add @memberof annotations
---
js/luigi-template.js | 16 ++++++++++++----
1 file changed, 12 insertions(+), 4 deletions(-)
diff --git a/js/luigi-template.js b/js/luigi-template.js
index 9c5556e..96dabd4 100644
--- a/js/luigi-template.js
+++ b/js/luigi-template.js
@@ -154,7 +154,9 @@ var Luigi = (function() {
var Luigi = {
/**
* Version of Luigi Template.
+ *
* @constant
+ * @memberof Luigi
* @default
*/
VERSION: '0.5.0',
@@ -163,6 +165,7 @@ var Luigi = (function() {
* Default filter set.
*
* @constant
+ * @memberof Luigi
* @default
*
* The default filters are:
@@ -231,6 +234,7 @@ var Luigi = (function() {
* Create a new Template instance.
*
* @constructor
+ * @memberof Luigi
*
* @param s {string} Template string (required).
* @param filters {hash} Filters (optional).
@@ -262,7 +266,8 @@ var Luigi = (function() {
/**
* Run template with given parameters.
*
- * @function Luigi.Template#run
+ * @function run
+ * @memberof Template
*
* @param args {hash} Template parameters (required).
* @param fn {function} Callback function (optional).
@@ -302,6 +307,7 @@ var Luigi = (function() {
* Create a new template cache.
*
* @constructor
+ * @memberof Luigi
*
* @param templates {hash} name to template map (required).
* @param filters {hash} custom filter map (optional).
@@ -316,7 +322,7 @@ var Luigi = (function() {
/**
* Find named template in cache and run it with the given arguments.
*
- * @function Luigi.Cache#run
+ * @function Cache#run
*
* @param key {hash} Template key (required).
* @param args {hash} Template run arguments (required).
@@ -350,7 +356,8 @@ var Luigi = (function() {
* Create a new template cache with the given templates and
* (optionally) filters.
*
- * @function Luigi.cache
+ * @function cache
+ * @memberof Luigi
*
* @param templates {hash} name to template map (required).
* @param filters {hash} custom filter map (optional).
@@ -382,7 +389,8 @@ var Luigi = (function() {
* Create and run template with given template string, parameters, and
* (optionally) filters.
*
- * @function Luigi.run
+ * @function run
+ * @memberof Luigi
*
* @param template {string} Template parameters (required).
* @param args {hash} Template parameters (required).
--
cgit v1.2.3