API documentation updates

This commit is contained in:
Nick O'Leary
2018-12-05 13:00:25 +00:00
parent ee47646cf7
commit 8e1c15419c
7 changed files with 124 additions and 62 deletions

View File

@@ -15,10 +15,10 @@
* @ignore
**/
/**
* @module i18n
* @memberof module:@node-red/util
*/
/**
* Internationalization utilities
* @mixin @node-red/util_i18n
*/
var i18n = require("i18next");
@@ -34,7 +34,7 @@ var initPromise;
/**
* Register multiple message catalogs with i18n.
* @memberof module:@node-red/util.module:i18n
* @memberof @node-red/util_i18n
*/
function registerMessageCatalogs(catalogs) {
var promises = catalogs.map(function(catalog) {
@@ -45,7 +45,7 @@ function registerMessageCatalogs(catalogs) {
/**
* Register a message catalog with i18n.
* @memberof module:@node-red/util.module:i18n
* @memberof @node-red/util_i18n
*/
function registerMessageCatalog(namespace,dir,file) {
return initPromise.then(function() {
@@ -146,7 +146,7 @@ function init() {
* Gets a message catalog.
* @name catalog
* @function
* @memberof module:@node-red/util.module:i18n
* @memberof @node-red/util_i18n
*/
function getCatalog(namespace,lang) {
var result = null;
@@ -182,7 +182,7 @@ var obj = module.exports = {
* Perform a message catalog lookup.
* @name _
* @function
* @memberof module:@node-red/util.module:i18n
* @memberof @node-red/util_i18n
*/
obj['_'] = function() {
//var opts = {};