Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix buildModuleUrl.setBaseUrl and .getCesiumBaseUrl in JSDoc/TypeScript #9783

Closed
wants to merge 1 commit into from
Closed

Fix buildModuleUrl.setBaseUrl and .getCesiumBaseUrl in JSDoc/TypeScript #9783

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion Source/Core/buildModuleUrl.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ var implementation;

/**
* Given a relative URL under the Cesium base URL, returns an absolute URL.
* @function
* @function buildModuleUrl
*
* @param {String} relativeUrl The relative path.
* @returns {String} The absolutely URL representation of the provided path.
Expand Down Expand Up @@ -130,9 +130,14 @@ buildModuleUrl._clearBaseResource = function () {
baseResource = undefined;
};

/** @namespace buildModuleUrl(1) */

/**
* Sets the base URL for resolving modules.
* @function setBaseUrl
* @memberof buildModuleUrl(1)
* @param {String} value The new base URL.
* @return {Void} void
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Throughout the codebase, we omit the return tag if the return type is void.

*/
buildModuleUrl.setBaseUrl = function (value) {
baseResource = Resource.DEFAULT.getDerivedResource({
Expand All @@ -142,6 +147,9 @@ buildModuleUrl.setBaseUrl = function (value) {

/**
* Gets the base URL for resolving modules.
* @function getCesiumBaseUrl
* @memberof buildModuleUrl(1)
* @return {Resource} The base URL for resolving modules.
*/
buildModuleUrl.getCesiumBaseUrl = getCesiumBaseUrl;

Expand Down