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.

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

Enable eslint-jsdoc #12019

Open
wants to merge 9 commits into
base: main
Choose a base branch
from
Prev Previous commit
Fix documentation guide
  • Loading branch information
ggetz committed Jun 4, 2024
commit 26a6bab8bd32a7bad3855ee0e49935f2b4dd1bf4
10 changes: 5 additions & 5 deletions Documentation/Contributors/DocumentationGuide/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -240,7 +240,7 @@ CesiumMath.EPSILON1 = 0.1;
* interface and is not intended to be instantiated directly.
*
* @alias TerrainProvider
* @constructor
* @class
*
* @see EllipsoidTerrainProvider
* @see CesiumTerrainProvider
Expand All @@ -264,14 +264,14 @@ function TerrainProvider() {

## Classes

Define a class with `@alias` and `@constructor` tags on the constructor function, e.g.,
Define a class with `@alias` and `@class` tags on the constructor function, e.g.,

```javascript
/**
* A 3D Cartesian point.
*
* @alias Cartesian3
* @constructor
* @class
*
* ...
*/
Expand Down Expand Up @@ -423,7 +423,7 @@ If a member or function doesn't start with `_`, but is intended to be private, u
* one using {@link Scene#tweens} and {@link TweenCollection#add} and related add functions.
*
* @alias Tween
* @constructor
* @class
*
* @private
*/
Expand Down Expand Up @@ -459,7 +459,7 @@ There's a general flow to each documentation block that makes it easy to read. T
DESCRIPTION.

@alias NAME
@constructor
@class

@param {TYPE} NAME DESCRIPTION.
@param {TYPE|OTHER_TYPE} NAME DESCRIPTION WITH LONG
Expand Down
2 changes: 1 addition & 1 deletion packages/engine/Source/Core/GeometryAttributes.js
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ import defaultValue from "./defaultValue.js";
* <p>
* Attributes are always stored non-interleaved in a Geometry.
* </p>
* @param options
* @param {Object} [options]
* @alias GeometryAttributes
* @class
*/
Expand Down
2 changes: 1 addition & 1 deletion packages/engine/Source/Scene/GlobeSurfaceTileProvider.js
Original file line number Diff line number Diff line change
Expand Up @@ -58,8 +58,8 @@ import TileSelectionResult from "./TileSelectionResult.js";
* with {@link QuadtreePrimitive}.
* @alias GlobeSurfaceTileProvider
* @class
* @param {Object} [options] Object with the following properties:
* @param {TerrainProvider} options.terrainProvider The terrain provider that describes the surface geometry.
* @param options
* @param {ImageryLayerCollection} option.imageryLayers The collection of imagery layers describing the shading of the surface.
* @param {GlobeSurfaceShaderSet} options.surfaceShaderSet The set of shaders used to render the surface.
* @private
Expand Down
2 changes: 1 addition & 1 deletion packages/engine/Source/Scene/ImageBasedLighting.js
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@ import OctahedralProjectedCubeMap from "./OctahedralProjectedCubeMap.js";
* </p>
* @alias ImageBasedLighting
* @class
* @param {Object} [options] Object with the following properties:
* @param {Cartesian2} [options.imageBasedLightingFactor=Cartesian2(1.0, 1.0)] Scales diffuse and specular image-based lighting from the earth, sky, atmosphere and star skybox.
* @param options
* @param {number} [options.luminanceAtZenith=0.2] The sun's luminance at the zenith in kilo candela per meter squared to use for this model's procedural environment map.
* @param {Cartesian3[]} [options.sphericalHarmonicCoefficients] The third order spherical harmonic coefficients used for the diffuse color of image-based lighting.
* @param {string} [options.specularEnvironmentMaps] A URL to a KTX2 file that contains a cube map of the specular lighting and the convoluted specular mipmaps.
Expand Down
2 changes: 1 addition & 1 deletion packages/engine/Source/Scene/ImplicitMetadataView.js
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@ import defaultValue from "../Core/defaultValue.js";
* <p>
* See the {@link https://github.com/CesiumGS/3d-tiles/tree/main/extensions/3DTILES_metadata|3DTILES_metadata Extension} for 3D Tiles
* </p>
* @param {Object} [options] Object with the following properties:
* @param {MetadataTable} options.metadataTable The metadata table.
* @param {MetadataClass} options.class The class that the metadata conforms to.
* @param {number} options.entityId The ID of the entity the metadata belongs to.
* @param {object} options.propertyTableJson The JSON that contains the property table of the entity.
* @param options
* @alias ImplicitMetadataView
* @class
* @private
Expand Down
2 changes: 1 addition & 1 deletion packages/engine/Source/Scene/QuadtreeTile.js
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ import TileSelectionResult from "./TileSelectionResult.js";
* @alias QuadtreeTile
* @class
* @private
* @param {Object} options Object with the following properties:
* @param {number} options.level The level of the tile in the quadtree.
* @param options
* @param {number} options.x The X coordinate of the tile in the quadtree. 0 is the westernmost tile.
* @param {number} options.y The Y coordinate of the tile in the quadtree. 0 is the northernmost tile.
* @param {TilingScheme} options.tilingScheme The tiling scheme in which this tile exists.
Expand Down