From 597255fb9bb6bb3127e2ac4250583b4147ff1201 Mon Sep 17 00:00:00 2001 From: Tom Coleman Date: Fri, 19 Feb 2016 10:42:31 +1100 Subject: [PATCH] Updated to jsdoc 3.4.0 and use `@class name` to make it work the same --- docs/client/data.js | 82 ++++++++++++++++------- docs/client/names.json | 2 + packages/accounts-base/accounts_client.js | 2 +- packages/accounts-base/accounts_server.js | 2 +- scripts/admin/jsdoc/package.json | 2 +- 5 files changed, 62 insertions(+), 28 deletions(-) diff --git a/docs/client/data.js b/docs/client/data.js index 4fd831fef0..536e70deb3 100644 --- a/docs/client/data.js +++ b/docs/client/data.js @@ -1,9 +1,9 @@ // This file is automatically generated by JSDoc; regenerate it with scripts/admin/jsdoc/jsdoc.sh DocsData = { "Accounts": { - "filepath": "accounts-base/globals_server.js", + "filepath": "accounts-base/server_main.js", "kind": "namespace", - "lineno": 1, + "lineno": 5, "longname": "Accounts", "name": "Accounts", "scope": "global", @@ -285,7 +285,7 @@ DocsData = { "filepath": "accounts-base/url_client.js", "forceMemberof": true, "kind": "member", - "lineno": 115, + "lineno": 117, "locus": "Client", "longname": "Accounts.onEmailVerificationLink", "memberof": "Accounts", @@ -308,7 +308,7 @@ DocsData = { "filepath": "accounts-base/url_client.js", "forceMemberof": true, "kind": "member", - "lineno": 142, + "lineno": 144, "locus": "Client", "longname": "Accounts.onEnrollmentLink", "memberof": "Accounts", @@ -331,7 +331,7 @@ DocsData = { "filepath": "accounts-base/url_client.js", "forceMemberof": true, "kind": "member", - "lineno": 89, + "lineno": 91, "locus": "Client", "longname": "Accounts.onResetPasswordLink", "memberof": "Accounts", @@ -715,7 +715,7 @@ DocsData = { "filepath": "accounts-base/accounts_client.js", "instancename": "accountsClient", "kind": "class", - "lineno": 11, + "lineno": 3, "locus": "Client", "longname": "AccountsClient", "name": "AccountsClient", @@ -827,7 +827,7 @@ DocsData = { "AccountsClient#loggingIn": { "filepath": "accounts-base/accounts_client.js", "kind": "function", - "lineno": 54, + "lineno": 56, "locus": "Client", "longname": "AccountsClient#loggingIn", "memberof": "AccountsClient", @@ -840,7 +840,7 @@ DocsData = { "AccountsClient#logout": { "filepath": "accounts-base/accounts_client.js", "kind": "function", - "lineno": 64, + "lineno": 66, "locus": "Client", "longname": "AccountsClient#logout", "memberof": "AccountsClient", @@ -864,7 +864,7 @@ DocsData = { "AccountsClient#logoutOtherClients": { "filepath": "accounts-base/accounts_client.js", "kind": "function", - "lineno": 83, + "lineno": 85, "locus": "Client", "longname": "AccountsClient#logoutOtherClients", "memberof": "AccountsClient", @@ -1137,7 +1137,7 @@ DocsData = { "filepath": "accounts-base/accounts_server.js", "instancename": "accountsServer", "kind": "class", - "lineno": 11, + "lineno": 5, "locus": "Server", "longname": "AccountsServer", "name": "AccountsServer", @@ -1230,7 +1230,7 @@ DocsData = { "AccountsServer#onCreateUser": { "filepath": "accounts-base/accounts_server.js", "kind": "function", - "lineno": 116, + "lineno": 118, "locus": "Server", "longname": "AccountsServer#onCreateUser", "memberof": "AccountsServer", @@ -1334,7 +1334,7 @@ DocsData = { "AccountsServer#validateLoginAttempt": { "filepath": "accounts-base/accounts_server.js", "kind": "function", - "lineno": 93, + "lineno": 95, "locus": "Server", "longname": "AccountsServer#validateLoginAttempt", "memberof": "AccountsServer", @@ -1357,7 +1357,7 @@ DocsData = { "AccountsServer#validateNewUser": { "filepath": "accounts-base/accounts_server.js", "kind": "function", - "lineno": 103, + "lineno": 105, "locus": "Server", "longname": "AccountsServer#validateNewUser", "memberof": "AccountsServer", @@ -4480,7 +4480,7 @@ DocsData = { "Meteor": { "filepath": "meteor/client_environment.js", "kind": "namespace", - "lineno": 1, + "lineno": 3, "longname": "Meteor", "name": "Meteor", "scope": "global", @@ -4489,7 +4489,7 @@ DocsData = { "Meteor.Error": { "filepath": "meteor/errors.js", "kind": "class", - "lineno": 78, + "lineno": 71, "locus": "Anywhere", "longname": "Meteor.Error", "memberof": "Meteor", @@ -4769,7 +4769,7 @@ DocsData = { "Meteor.isClient": { "filepath": "meteor/client_environment.js", "kind": "member", - "lineno": 13, + "lineno": 30, "locus": "Anywhere", "longname": "Meteor.isClient", "memberof": "Meteor", @@ -4798,10 +4798,42 @@ DocsData = { ] } }, + "Meteor.isDevelopment": { + "filepath": "meteor/client_environment.js", + "kind": "member", + "lineno": 22, + "locus": "Anywhere", + "longname": "Meteor.isDevelopment", + "memberof": "Meteor", + "name": "isDevelopment", + "scope": "static", + "summary": "Boolean variable. True if running in development environment.", + "type": { + "names": [ + "Boolean" + ] + } + }, + "Meteor.isProduction": { + "filepath": "meteor/client_environment.js", + "kind": "member", + "lineno": 14, + "locus": "Anywhere", + "longname": "Meteor.isProduction", + "memberof": "Meteor", + "name": "isProduction", + "scope": "static", + "summary": "Boolean variable. True if running in production environment.", + "type": { + "names": [ + "Boolean" + ] + } + }, "Meteor.isServer": { "filepath": "meteor/client_environment.js", "kind": "member", - "lineno": 21, + "lineno": 38, "locus": "Anywhere", "longname": "Meteor.isServer", "memberof": "Meteor", @@ -4817,7 +4849,7 @@ DocsData = { "Meteor.loggingIn": { "filepath": "accounts-base/accounts_client.js", "kind": "function", - "lineno": 134, + "lineno": 136, "locus": "Client", "longname": "Meteor.loggingIn", "memberof": "Meteor", @@ -4961,7 +4993,7 @@ DocsData = { "Meteor.logout": { "filepath": "accounts-base/accounts_client.js", "kind": "function", - "lineno": 334, + "lineno": 336, "locus": "Client", "longname": "Meteor.logout", "memberof": "Meteor", @@ -4985,7 +5017,7 @@ DocsData = { "Meteor.logoutOtherClients": { "filepath": "accounts-base/accounts_client.js", "kind": "function", - "lineno": 343, + "lineno": 345, "locus": "Client", "longname": "Meteor.logoutOtherClients", "memberof": "Meteor", @@ -5180,7 +5212,7 @@ DocsData = { "Meteor.settings": { "filepath": "meteor/client_environment.js", "kind": "member", - "lineno": 32, + "lineno": 49, "locus": "Anywhere", "longname": "Meteor.settings", "memberof": "Meteor", @@ -5300,9 +5332,9 @@ DocsData = { "summary": "Get the current user id, or `null` if no user is logged in. A reactive data source." }, "Meteor.users": { - "filepath": "accounts-base/globals_server.js", + "filepath": "accounts-base/server_main.js", "kind": "member", - "lineno": 16, + "lineno": 20, "locus": "Anywhere", "longname": "Meteor.users", "memberof": "Meteor", @@ -7947,7 +7979,7 @@ DocsData = { "filepath": "accounts-base/accounts_client.js", "ishelper": "true", "kind": "member", - "lineno": 410, + "lineno": 412, "longname": "currentUser", "name": "currentUser", "scope": "global", @@ -8174,7 +8206,7 @@ DocsData = { "filepath": "accounts-base/accounts_client.js", "ishelper": "true", "kind": "member", - "lineno": 420, + "lineno": 422, "longname": "loggingIn", "name": "loggingIn", "scope": "global", diff --git a/docs/client/names.json b/docs/client/names.json index 49d778fd25..b9e64944d3 100644 --- a/docs/client/names.json +++ b/docs/client/names.json @@ -165,6 +165,8 @@ "Meteor.disconnect", "Meteor.isClient", "Meteor.isCordova", + "Meteor.isDevelopment", + "Meteor.isProduction", "Meteor.isServer", "Meteor.loggingIn", "Meteor.loginWith", diff --git a/packages/accounts-base/accounts_client.js b/packages/accounts-base/accounts_client.js index ed46d8d6c3..129ee046cf 100644 --- a/packages/accounts-base/accounts_client.js +++ b/packages/accounts-base/accounts_client.js @@ -3,7 +3,7 @@ import {AccountsCommon} from "./accounts_common.js"; /** * @summary Constructor for the `Accounts` object on the client. * @locus Client - * @class + * @class AccountsClient * @extends AccountsCommon * @instancename accountsClient * @param {Object} options an object with fields: diff --git a/packages/accounts-base/accounts_server.js b/packages/accounts-base/accounts_server.js index 19ce5aaf30..6783d1ff8b 100644 --- a/packages/accounts-base/accounts_server.js +++ b/packages/accounts-base/accounts_server.js @@ -5,7 +5,7 @@ import {AccountsCommon} from "./accounts_common.js"; /** * @summary Constructor for the `Accounts` namespace on the server. * @locus Server - * @class + * @class AccountsServer * @extends AccountsCommon * @instancename accountsServer * @param {Object} server A server object such as `Meteor.server`. diff --git a/scripts/admin/jsdoc/package.json b/scripts/admin/jsdoc/package.json index a69de9a4ed..5885bb5fa6 100644 --- a/scripts/admin/jsdoc/package.json +++ b/scripts/admin/jsdoc/package.json @@ -5,7 +5,7 @@ "readme": "no warn", "repository": "no warn", "dependencies": { - "jsdoc": "jsdoc3/jsdoc#99fb8a00", + "jsdoc": "3.4.0", "canonical-json": "0.0.4" } }