summaryrefslogtreecommitdiffstats
path: root/install/ui/src/freeipa/metadata.js
diff options
context:
space:
mode:
Diffstat (limited to 'install/ui/src/freeipa/metadata.js')
-rw-r--r--install/ui/src/freeipa/metadata.js16
1 files changed, 16 insertions, 0 deletions
diff --git a/install/ui/src/freeipa/metadata.js b/install/ui/src/freeipa/metadata.js
index d33d3ae8..cfdc91b1 100644
--- a/install/ui/src/freeipa/metadata.js
+++ b/install/ui/src/freeipa/metadata.js
@@ -24,6 +24,22 @@ define([
'./_base/Search_provider'
], function(lang, Provider, Search_provider) {
+ /**
+ * Metadata provider
+ *
+ * Contains multiple providers for specific metadata searches:
+ *
+ * - `@m:`: provider for whole metadata
+ * - `@mo:`: provider for objects (entities)
+ * - `@mc:`: provider for commands
+ * - `@mo-param:`: search provider for object params
+ * - `@mc-arg:`: search provider for command arguments
+ * - `@mc-opt:`: search provider for command options
+ *
+ * @class metadata
+ * @singleton
+ * @extends _base.Provider
+ */
var metadata = new Provider({
code: '@m:'
});