Skip to content

Commit

Permalink
Merge pull request #1341 from dcleao/BACKLOG-26361-8.2.0.0
Browse files Browse the repository at this point in the history
[BACKLOG-26361] Fixes to VizAPI's JsDocs documentation.
  • Loading branch information
pamval authored Nov 12, 2018
2 parents 93bb0a6 + 340eca8 commit 715e51e
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 6 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -57,8 +57,6 @@ define([
*
* For additional information, see the associated _instance class_, {@link pentaho.type.Instance}.
*
* This constructor is the value of {@link pentaho.type.InstanceType}.
*
* @description _Initializes_ the type's singleton object.
* @param {Object} spec - The specification of this type.
* @param {!Object} keyArgs - Keyword arguments.
Expand Down
10 changes: 10 additions & 0 deletions impl/client/src/main/javascript/web/pentaho/type/loader.js
Original file line number Diff line number Diff line change
Expand Up @@ -22,5 +22,15 @@ define([

"use strict";

/**
* The global _Type API_ loader instance.
*
* Loading this module also pre-loads all standard _Type API_ types.
*
* @name loader
* @type {pentaho.type.ILoader}
* @memberOf pentaho.type
*/

return baseLoader;
});
8 changes: 4 additions & 4 deletions impl/client/src/main/javascript/web/pentaho/util/url.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*!
* Copyright 2017 Hitachi Vantara. All rights reserved.
* Copyright 2017-2018 Hitachi Vantara. All rights reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand Down Expand Up @@ -40,7 +40,7 @@ define([
* available, {@code url} is going to be parsed and a URL mock
* will be returned instead.
*
* @param {?String} url - A resource location.
* @param {?string} url - A resource location.
*
* @return {?URL} the new URL object.
*/
Expand All @@ -56,9 +56,9 @@ define([
* 4. port (optional)
* 5. pathname (optional)
*
* @param {String} url - A resource location.
* @param {string} url - A resource location.
*
* @return {Array.<String>} the parsed url.
* @return {Array.<string>} the parsed url.
*/
parse: parseUrl
};
Expand Down

0 comments on commit 715e51e

Please sign in to comment.