Merge pull request meteor#7980 from meteor/fix-jsdocs

JSdoc refactoring to make API boxes work again.

packages/ddp-common/method_invocation.js

@@ -5,6 +5,7 @@
  * inside a method definition.
  * @param {Object} options
  * @instanceName this
+ * @showInstanceName true
  */
 DDPCommon.MethodInvocation = function (options) {
   var self = this;
@@ -51,7 +52,7 @@ DDPCommon.MethodInvocation = function (options) {
   // On the server, the connection this method call came in on.
 
   /**
-   * @summary Access inside a method invocation. The [connection](#meteor_onconnection) that this method was received on. `null` if the method is not associated with a connection, eg. a server initiated method call. Calls to methods made from a server method which was in turn initiated from the client share the same `connection`. 
+   * @summary Access inside a method invocation. The [connection](#meteor_onconnection) that this method was received on. `null` if the method is not associated with a connection, eg. a server initiated method call. Calls to methods made from a server method which was in turn initiated from the client share the same `connection`.
    * @locus Server
    * @name  connection
    * @memberOf DDPCommon.MethodInvocation
@@ -94,4 +95,3 @@ _.extend(DDPCommon.MethodInvocation.prototype, {
     self._setUserId(userId);
   }
 });
-

packages/ddp-server/livedata_server.js

@@ -937,6 +937,7 @@ _.extend(Session.prototype, {
  * @summary The server's side of a subscription
  * @class Subscription
  * @instanceName this
+ * @showInstanceName true
  */
 var Subscription = function (
     session, handler, subscriptionId, params, name) {

tools/isobuild/package-api.js

@@ -74,6 +74,7 @@ function forAllMatchingArchs (archs, f) {
  * @name  PackageAPI
  * @class PackageAPI
  * @instanceName api
+ * @showInstanceName true
  * @global
  * @summary Type of the API object passed into the `Package.onUse` function.
  */

tools/isobuild/package-cordova.js

@@ -1,9 +1,13 @@
 import { ensureOnlyValidVersions } from "../utils/utils.js";
 import buildmessage from "../utils/buildmessage.js";
 
-// == Class of the `Cordova` object visible in package.js ==
-
 export class PackageCordova {
+  /**
+   * @summary Class of the 'Cordova' object visible in package.js
+   * @locus package.js
+   * @instanceName Cordova
+   * @showInstanceName true
+   */
   constructor() {
     this._dependencies = null;
   }
@@ -39,7 +43,6 @@ export class PackageCordova {
    * ```
    *
    * @locus package.js
-   * @memberOf  Cordova
    */
   depends(dependencies) {
     // XXX make cordovaDependencies be separate between use and test, so that

tools/isobuild/package-namespace.js

@@ -3,9 +3,13 @@ import { inCheckout } from "../fs/files.js";
 import buildmessage from "../utils/buildmessage.js";
 import packageVersionParser from "../packaging/package-version-parser.js";
 
-// == Class of the 'Package' object visible in package.js ==
-
 export class PackageNamespace {
+  /**
+   * @summary Class of the 'Package' object visible in package.js
+   * @locus package.js
+   * @instanceName Package
+   * @showInstanceName true
+   */
   constructor(packageSource) {
     this._packageSource = packageSource;
     this._fileAndDepLoader = null;
@@ -22,7 +26,7 @@ export class PackageNamespace {
   /**
    * @summary Provide basic package information.
    * @locus package.js
-   * @memberOf Package
+   * @memberOf PackageNamespace
    * @param {Object} options
    * @param {String} options.summary A concise 1-2 sentence description of
    * the package, required for publication.
@@ -149,7 +153,6 @@ export class PackageNamespace {
   /**
    * @summary Define package dependencies and expose package methods.
    * @locus package.js
-   * @memberOf Package
    * @param {Function} func A function that takes in the package control `api` object, which keeps track of dependencies and exports.
    */
   onUse(f) {
@@ -175,7 +178,6 @@ export class PackageNamespace {
   /**
    * @summary Define dependencies and expose package methods for unit tests.
    * @locus package.js
-   * @memberOf Package
    * @param {Function} func A function that takes in the package control 'api' object, which keeps track of dependencies and exports.
    */
   onTest(f) {
@@ -245,7 +247,6 @@ export class PackageNamespace {
    * @param {Object} options.npmDependencies An object where the keys
    * are NPM package names, and the values are the version numbers of
    * required NPM packages, just like in [Npm.depends](#Npm-depends).
-   * @memberOf Package
    * @locus package.js
    */
   registerBuildPlugin(options) {

tools/isobuild/package-npm.js

@@ -4,9 +4,13 @@ import NpmDiscards from "./npm-discards.js";
 
 const nodeRequire = require;
 
-// == Class of the `Npm` object visible in package.js ==
-
 export class PackageNpm {
+  /**
+   * @summary Class of the 'Npm' object visible in package.js
+   * @locus package.js
+   * @instanceName Npm
+   * @showInstanceName true
+   */
   constructor() {
     // Files to be stripped from the installed NPM dependency tree. See
     // the Npm.strip comment below for further usage information.
@@ -20,7 +24,7 @@ export class PackageNpm {
    * @param  {Object} dependencies An object where the keys are package
    * names and the values are one of:
    *   1. Version numbers in string form
-   *   2. Http(s) URLs to a git commit by SHA.   
+   *   2. Http(s) URLs to a git commit by SHA.
    *   3. Git URLs in the format described [here](https://docs.npmjs.com/files/package.json#git-urls-as-dependencies)
    *
    * Https URL example:
@@ -41,7 +45,6 @@ export class PackageNpm {
    * });
    * ```
    * @locus package.js
-   * @memberOf  Npm
    */
   depends(dependencies) {
     // XXX make dependencies be separate between use and test, so that