Fix jsdoc/tag-lines

CesiumGS · ggetz · Jun 4, 2024 · Jun 4, 2024 · Jun 4, 2024 · Jun 4, 2024
commit ed3c29ee31bf068a948e9c31ee58e871ddea03b9
diff --git a/eslint.config.js b/eslint.config.js
@@ -77,7 +77,6 @@ export default [
       "jsdoc/check-property-names": "off",
       "jsdoc/check-types": "off",
       "jsdoc/valid-types": "off",
-      "jsdoc/tag-lines": "off",
       "jsdoc/no-defaults": "off", // We use default parameters instead of enforcing with ES6 for now
     },
   },

diff --git a/packages/engine/Source/Core/CircleGeometry.js b/packages/engine/Source/Core/CircleGeometry.js
@@ -21,10 +21,8 @@ import VertexFormat from "./VertexFormat.js";
  * @param {number} [options.stRotation] The rotation of the texture coordinates, in radians. A positive rotation is counter-clockwise.
  * @throws {DeveloperError} radius must be greater than zero.
  * @throws {DeveloperError} granularity must be greater than zero.
- *
  * @see CircleGeometry.createGeometry
  * @see Packable
- *
  * @example
  * // Create a circle.
  * const circle = new Cesium.CircleGeometry({

diff --git a/packages/engine/Source/Core/CircleOutlineGeometry.js b/packages/engine/Source/Core/CircleOutlineGeometry.js
@@ -19,10 +19,8 @@ import Ellipsoid from "./Ellipsoid.js";
  * @param {number} [options.numberOfVerticalLines] Number of lines to draw between the top and bottom of an extruded circle.
  * @throws {DeveloperError} radius must be greater than zero.
  * @throws {DeveloperError} granularity must be greater than zero.
- *
  * @see CircleOutlineGeometry.createGeometry
  * @see Packable
- *
  * @example
  * // Create a circle.
  * const circle = new Cesium.CircleOutlineGeometry({

diff --git a/packages/engine/Source/Core/Clock.js b/packages/engine/Source/Core/Clock.js
@@ -21,7 +21,6 @@ import JulianDate from "./JulianDate.js";
  * @param {boolean} [options.canAnimate] Indicates whether {@link Clock#tick} can advance time.  This could be false if data is being buffered, for example.  The clock will only tick when both {@link Clock#canAnimate} and {@link Clock#shouldAnimate} are true.
  * @param {boolean} [options.shouldAnimate] Indicates whether {@link Clock#tick} should attempt to advance time.  The clock will only tick when both {@link Clock#canAnimate} and {@link Clock#shouldAnimate} are true.
  * @throws {DeveloperError} startTime must come before stopTime.
- *
  * @example
  * // Create a clock that loops on Christmas day 2013 and runs in real-time.
  * const clock = new Cesium.Clock({
@@ -31,7 +30,6 @@ import JulianDate from "./JulianDate.js";
  *    clockRange : Cesium.ClockRange.LOOP_STOP,
  *    clockStep : Cesium.ClockStep.SYSTEM_CLOCK_MULTIPLIER
  * });
- *
  * @see ClockStep
  * @see ClockRange
  * @see JulianDate

diff --git a/packages/engine/Source/Core/Color.js b/packages/engine/Source/Core/Color.js
@@ -235,7 +235,6 @@ Color.fromHsl = function (hue, saturation, lightness, alpha, result) {
  * @throws {DeveloperError} minimumGreen must be less than or equal to maximumGreen.
  * @throws {DeveloperError} minimumBlue must be less than or equal to maximumBlue.
  * @throws {DeveloperError} minimumAlpha must be less than or equal to maximumAlpha.
- *
  * @example
  * //Create a completely random color
  * const color = Cesium.Color.fromRandom();

diff --git a/packages/engine/Source/Core/CylinderOutlineGeometry.js b/packages/engine/Source/Core/CylinderOutlineGeometry.js
@@ -31,9 +31,7 @@ const radiusScratch = new Cartesian2();
  * @throws {DeveloperError} options.bottomRadius must be greater than 0.
  * @throws {DeveloperError} bottomRadius and topRadius cannot both equal 0.
  * @throws {DeveloperError} options.slices must be greater than or equal to 3.
- *
  * @see CylinderOutlineGeometry.createGeometry
- *
  * @example
  * // create cylinder geometry
  * const cylinder = new Cesium.CylinderOutlineGeometry({

diff --git a/packages/engine/Source/Core/EllipseGeometry.js b/packages/engine/Source/Core/EllipseGeometry.js
@@ -900,8 +900,6 @@ function computeRectangle(
  * @throws {DeveloperError} semiMajorAxis and semiMinorAxis must be greater than zero.
  * @throws {DeveloperError} semiMajorAxis must be greater than or equal to the semiMinorAxis.
  * @throws {DeveloperError} granularity must be greater than zero.
- *
- *
  * @example
  * // Create an ellipse.
  * const ellipse = new Cesium.EllipseGeometry({
@@ -911,7 +909,6 @@ function computeRectangle(
  *   rotation : Cesium.Math.toRadians(60.0)
  * });
  * const geometry = Cesium.EllipseGeometry.createGeometry(ellipse);
- *
  * @see EllipseGeometry.createGeometry
  */
 function EllipseGeometry(options) {

diff --git a/packages/engine/Source/Core/EllipseOutlineGeometry.js b/packages/engine/Source/Core/EllipseOutlineGeometry.js
@@ -195,9 +195,7 @@ function computeExtrudedEllipse(options) {
  * @throws {DeveloperError} semiMajorAxis and semiMinorAxis must be greater than zero.
  * @throws {DeveloperError} semiMajorAxis must be greater than or equal to the semiMinorAxis.
  * @throws {DeveloperError} granularity must be greater than zero.
- *
  * @see EllipseOutlineGeometry.createGeometry
- *
  * @example
  * const ellipse = new Cesium.EllipseOutlineGeometry({
  *   center : Cesium.Cartesian3.fromDegrees(-75.59777, 40.03883),

diff --git a/packages/engine/Source/Core/EllipsoidGeometry.js b/packages/engine/Source/Core/EllipsoidGeometry.js
@@ -39,12 +39,9 @@ const sin = Math.sin;
  * @param {number} [options.stackPartitions] The number of times to partition the ellipsoid into stacks.
  * @param {number} [options.slicePartitions] The number of times to partition the ellipsoid into radial slices.
  * @param {VertexFormat} [options.vertexFormat=VertexFormat.DEFAULT] The vertex attributes to be computed.
- *
  * @throws {DeveloperError} options.slicePartitions cannot be less than three.
  * @throws {DeveloperError} options.stackPartitions cannot be less than three.
- *
  * @see EllipsoidGeometry#createGeometry
- *
  * @example
  * const ellipsoid = new Cesium.EllipsoidGeometry({
  *   vertexFormat : Cesium.VertexFormat.POSITION_ONLY,

diff --git a/packages/engine/Source/Core/EllipsoidOutlineGeometry.js b/packages/engine/Source/Core/EllipsoidOutlineGeometry.js
@@ -31,11 +31,9 @@ const sin = Math.sin;
  * @param {number} [options.stackPartitions] The count of stacks for the ellipsoid (1 greater than the number of parallel lines).
  * @param {number} [options.slicePartitions] The count of slices for the ellipsoid (Equal to the number of radial lines).
  * @param {number} [options.subdivisions=128] The number of points per line, determining the granularity of the curvature.
- *
  * @throws {DeveloperError} options.stackPartitions must be greater than or equal to one.
  * @throws {DeveloperError} options.slicePartitions must be greater than or equal to zero.
  * @throws {DeveloperError} options.subdivisions must be greater than or equal to zero.
- *
  * @example
  * const ellipsoid = new Cesium.EllipsoidOutlineGeometry({
  *   radii : new Cesium.Cartesian3(1000000.0, 500000.0, 500000.0),

diff --git a/packages/engine/Source/Core/HeightmapTerrainData.js b/packages/engine/Source/Core/HeightmapTerrainData.js
@@ -72,8 +72,6 @@ import TerrainProvider from "./TerrainProvider.js";
  * @param {HeightmapEncoding} [options.encoding] The encoding that is used on the buffer.
  * @param {boolean} [options.createdByUpsampling=false] True if this instance was created by upsampling another instance;
  *                  otherwise, false.
- *
- *
  * @example
  * const buffer = ...
  * const heightBuffer = new Uint16Array(buffer, 0, that._heightmapWidth * that._heightmapWidth);
@@ -86,7 +84,6 @@ import TerrainProvider from "./TerrainProvider.js";
  *   childTileMask : childTileMask,
  *   waterMask : waterMask
  * });
- *
  * @see TerrainData
  * @see QuantizedMeshTerrainData
  * @see GoogleEarthEnterpriseTerrainData

diff --git a/packages/engine/Source/Core/Matrix3.js b/packages/engine/Source/Core/Matrix3.js
@@ -20,7 +20,6 @@ import CesiumMath from "./Math.js";
  * @param {number} [column0Row2] The value for column 0, row 2.
  * @param {number} [column1Row2] The value for column 1, row 2.
  * @param {number} [column2Row2=0.0] The value for column 2, row 2.
- *
  * @see Matrix3.fromArray
  * @see Matrix3.fromColumnMajorArray
  * @see Matrix3.fromRowMajorArray

diff --git a/packages/engine/Source/Core/Matrix4.js b/packages/engine/Source/Core/Matrix4.js
@@ -30,7 +30,6 @@ import RuntimeError from "./RuntimeError.js";
  * @param {number} [column1Row3=0.0] The value for column 1, row 3.
  * @param {number} [column2Row3=0.0] The value for column 2, row 3.
  * @param {number} [column3Row3=0.0] The value for column 3, row 3.
- *
  * @see Matrix4.fromArray
  * @see Matrix4.fromColumnMajorArray
  * @see Matrix4.fromRowMajorArray

diff --git a/packages/engine/Source/Core/PolygonGeometry.js b/packages/engine/Source/Core/PolygonGeometry.js
@@ -590,12 +590,9 @@ function createGeometryFromPositionsExtruded(
  * @param {boolean} [options.closeBottom] When false, leaves off the bottom of an extruded polygon open.
  * @param {ArcType} [options.arcType=ArcType.GEODESIC] The type of line the polygon edges must follow. Valid options are {@link ArcType.GEODESIC} and {@link ArcType.RHUMB}.
  * @param {PolygonHierarchy} [options.textureCoordinates] Texture coordinates as a {@link PolygonHierarchy} of {@link Cartesian2} points. Has no effect for ground primitives.
- *
  * @see PolygonGeometry#createGeometry
  * @see PolygonGeometry#fromPositions
- *
  * @demo {@link https://sandcastle.cesium.com/index.html?src=Polygon.html|Cesium Sandcastle Polygon Demo}
- *
  * @example
  * // 1. create a polygon from points
  * const polygon = new Cesium.PolygonGeometry({
@@ -776,7 +773,6 @@ function PolygonGeometry(options) {
  *   ])
  * });
  * const geometry = Cesium.PolygonGeometry.createGeometry(polygon);
- *
  * @see PolygonGeometry#createGeometry
  */
 PolygonGeometry.fromPositions = function (options) {

diff --git a/packages/engine/Source/Core/PolylineGeometry.js b/packages/engine/Source/Core/PolylineGeometry.js
@@ -77,11 +77,8 @@ function interpolateColors(p0, p1, color0, color1, numPoints) {
  * @throws {DeveloperError} At least two positions are required.
  * @throws {DeveloperError} width must be greater than or equal to one.
  * @throws {DeveloperError} colors has an invalid length.
- *
  * @see PolylineGeometry#createGeometry
- *
  * @demo {@link https://sandcastle.cesium.com/index.html?src=Polyline.html|Cesium Sandcastle Polyline Demo}
- *
  * @example
  * // A polyline with two connected line segments
  * const polyline = new Cesium.PolylineGeometry({

diff --git a/packages/engine/Source/Core/RectangleGeometry.js b/packages/engine/Source/Core/RectangleGeometry.js
@@ -987,11 +987,8 @@ function computeRectangle(rectangle, granularity, rotation, ellipsoid, result) {
  * @throws {DeveloperError} <code>options.rectangle.east</code> must be in the interval [<code>-Pi</code>, <code>Pi</code>].
  * @throws {DeveloperError} <code>options.rectangle.west</code> must be in the interval [<code>-Pi</code>, <code>Pi</code>].
  * @throws {DeveloperError} <code>options.rectangle.north</code> must be greater than <code>options.rectangle.south</code>.
- *
  * @see RectangleGeometry#createGeometry
- *
  * @demo {@link https://sandcastle.cesium.com/index.html?src=Rectangle.html|Cesium Sandcastle Rectangle Demo}
- *
  * @example
  * // 1. create a rectangle
  * const rectangle = new Cesium.RectangleGeometry({

diff --git a/packages/engine/Source/Core/RectangleOutlineGeometry.js b/packages/engine/Source/Core/RectangleOutlineGeometry.js
@@ -255,9 +255,7 @@ function constructExtrudedRectangle(rectangleGeometry, computedOptions) {
  * @throws {DeveloperError} <code>options.rectangle.east</code> must be in the interval [<code>-Pi</code>, <code>Pi</code>].
  * @throws {DeveloperError} <code>options.rectangle.west</code> must be in the interval [<code>-Pi</code>, <code>Pi</code>].
  * @throws {DeveloperError} <code>options.rectangle.north</code> must be greater than <code>rectangle.south</code>.
- *
  * @see RectangleOutlineGeometry#createGeometry
- *
  * @example
  * const rectangle = new Cesium.RectangleOutlineGeometry({
  *   ellipsoid : Cesium.Ellipsoid.WGS84,

diff --git a/packages/engine/Source/Core/SimplePolylineGeometry.js b/packages/engine/Source/Core/SimplePolylineGeometry.js
@@ -70,7 +70,6 @@ function interpolateColors(p0, p1, color0, color1, minDistance, array, offset) {
  * @throws {DeveloperError} At least two positions are required.
  * @throws {DeveloperError} colors has an invalid length.
  * @see SimplePolylineGeometry#createGeometry
- *
  * @example
  * // A polyline with two connected line segments
  * const polyline = new Cesium.SimplePolylineGeometry({

diff --git a/packages/engine/Source/Core/SphereGeometry.js b/packages/engine/Source/Core/SphereGeometry.js
@@ -17,7 +17,6 @@ import VertexFormat from "./VertexFormat.js";
  * @throws {DeveloperError} options.slicePartitions cannot be less than three.
  * @throws {DeveloperError} options.stackPartitions cannot be less than three.
  * @see SphereGeometry#createGeometry
- *
  * @example
  * const sphere = new Cesium.SphereGeometry({
  *   radius : 100.0,

diff --git a/packages/engine/Source/Core/SphereOutlineGeometry.js b/packages/engine/Source/Core/SphereOutlineGeometry.js
@@ -16,7 +16,6 @@ import EllipsoidOutlineGeometry from "./EllipsoidOutlineGeometry.js";
  * @throws {DeveloperError} options.stackPartitions must be greater than or equal to one.
  * @throws {DeveloperError} options.slicePartitions must be greater than or equal to zero.
  * @throws {DeveloperError} options.subdivisions must be greater than or equal to zero.
- *
  * @example
  * const sphere = new Cesium.SphereOutlineGeometry({
  *   radius : 100.0,

diff --git a/packages/engine/Source/Core/WallGeometry.js b/packages/engine/Source/Core/WallGeometry.js
@@ -41,9 +41,7 @@ const scratchNormal = new Cartesian3();
  * @throws {DeveloperError} positions and minimumHeights must have the same length.
  * @see WallGeometry#createGeometry
  * @see WallGeometry#fromConstantHeight
- *
  * @demo {@link https://sandcastle.cesium.com/index.html?src=Wall.html|Cesium Sandcastle Wall Demo}
- *
  * @example
  * // create a wall that spans from ground level to 10000 meters
  * const wall = new Cesium.WallGeometry({

diff --git a/packages/engine/Source/Core/loadKTX2.js b/packages/engine/Source/Core/loadKTX2.js
@@ -68,7 +68,6 @@ loadKTX2.setKTX2SupportedFormats = function (
  * }).catch(function (error) {
  *     // an error occurred.
  * });
- *
  * @see {@link https://github.com/KhronosGroup/KTX-Specification|KTX file format}
  * @see {@link http://www.w3.org/TR/cors/|Cross-Origin Resource Sharing}
  * @see {@link http://wiki.commonjs.org/wiki/Promises/A|CommonJS Promises/A}

diff --git a/packages/engine/Source/Renderer/CubeMapFace.js b/packages/engine/Source/Renderer/CubeMapFace.js
@@ -293,7 +293,6 @@ CubeMapFace.prototype.copyFrom = function (options) {
  * @throws {DeveloperError} xOffset + source.width must be less than or equal to width.
  * @throws {DeveloperError} yOffset + source.height must be less than or equal to height.
  * @throws {DeveloperError} This CubeMap was destroyed, i.e., destroy() was called.
- *
  * @example
  * // Copy the framebuffer contents to the +x cube map face.
  * cubeMap.positiveX.copyFromFramebuffer();

diff --git a/packages/engine/Source/Renderer/Framebuffer.js b/packages/engine/Source/Renderer/Framebuffer.js
@@ -45,7 +45,6 @@ function attachRenderbuffer(framebuffer, attachment, renderbuffer) {
  * @throws {DeveloperError} The number of color attachments exceeds the number supported.
  * @throws {DeveloperError} The color-texture pixel datatype is HALF_FLOAT and the WebGL implementation does not support the EXT_color_buffer_half_float extension.
  * @throws {DeveloperError} The color-texture pixel datatype is FLOAT and the WebGL implementation does not support the EXT_color_buffer_float or WEBGL_color_buffer_float extensions.
- *
  * @example
  * // Create a framebuffer with color and depth texture attachments.
  * const width = context.canvas.clientWidth;
@@ -66,7 +65,6 @@ function attachRenderbuffer(framebuffer, attachment, renderbuffer) {
  *     pixelDatatype : PixelDatatype.UNSIGNED_SHORT
  *   })
  * });
- *
  * @private
  * @class
  */

diff --git a/packages/engine/Source/Renderer/FramebufferManager.js b/packages/engine/Source/Renderer/FramebufferManager.js
@@ -25,7 +25,6 @@ import PixelFormat from "../Core/PixelFormat.js";
  * @param {PixelFormat} [options.pixelFormat=undefined] The default pixel format to use when creating color attachments.
  * @throws {DeveloperError} Must enable at least one type of framebuffer attachment.
  * @throws {DeveloperError} Cannot have both a depth and depth-stencil attachment.
- *
  * @private
  * @class
  */

diff --git a/packages/engine/Source/Renderer/RenderState.js b/packages/engine/Source/Renderer/RenderState.js
@@ -400,8 +400,6 @@ let renderStateCache = {};
  * @throws {DeveloperError} renderState.viewport.width must be less than or equal to the maximum viewport width.
  * @throws {DeveloperError} renderState.viewport.height must be greater than or equal to zero.
  * @throws {DeveloperError} renderState.viewport.height must be less than or equal to the maximum viewport height.
- *
- *
  * @example
  * const defaults = {
  *     frontFace : WindingOrder.COUNTER_CLOCKWISE,
@@ -480,10 +478,8 @@ let renderStateCache = {};
  * };
  *
  * const rs = RenderState.fromCache(defaults);
- *
  * @see DrawCommand
  * @see ClearCommand
- *
  * @private
  */
 RenderState.fromCache = function (renderState) {

diff --git a/packages/engine/Source/Renderer/Texture.js b/packages/engine/Source/Renderer/Texture.js
@@ -428,16 +428,12 @@ Texture.create = function (options) {
  * @throws {DeveloperError} framebufferYOffset must be greater than or equal to zero.
  * @throws {DeveloperError} framebufferXOffset + width must be less than or equal to canvas.clientWidth.
  * @throws {DeveloperError} framebufferYOffset + height must be less than or equal to canvas.clientHeight.
- *
- *
  * @example
  * // Create a texture with the contents of the framebuffer.
  * const t = Texture.fromFramebuffer({
  *     context : context
  * });
- *
  * @see Sampler
- *
  * @private
  */
 Texture.fromFramebuffer = function (options) {
@@ -661,7 +657,6 @@ Object.defineProperties(Texture.prototype, {
  * @throws {DeveloperError} xOffset + source.width must be less than or equal to width.
  * @throws {DeveloperError} yOffset + source.height must be less than or equal to height.
  * @throws {DeveloperError} This texture was destroyed, i.e., destroy() was called.
- *
  * @example
  * texture.copyFrom({
  *  source: {

diff --git a/packages/engine/Source/Renderer/VertexArray.js b/packages/engine/Source/Renderer/VertexArray.js
@@ -212,7 +212,6 @@ function bind(gl, attributes, indexBuffer) {
  *     context : context,
  *     attributes : attributes
  * });
- *
  * @example
  * // Example 2. Create a vertex array with vertices from two different vertex buffers.
  * // Each vertex has a three-component position and three-component normal.
@@ -244,7 +243,6 @@ function bind(gl, attributes, indexBuffer) {
  *     context : context,
  *     attributes : attributes
  * });
- *
  * @example
  * // Example 3. Creates the same vertex layout as Example 2 using a single
  * // vertex buffer, instead of two.
@@ -274,11 +272,9 @@ function bind(gl, attributes, indexBuffer) {
  *     context : context,
  *     attributes : attributes
  * });
- *
  * @see Buffer#createVertexBuffer
  * @see Buffer#createIndexBuffer
  * @see Context#draw
- *
  * @private
  */
 function VertexArray(options) {

diff --git a/packages/engine/Source/Scene/ClassificationPrimitive.js b/packages/engine/Source/Scene/ClassificationPrimitive.js
@@ -61,7 +61,6 @@ import StencilOperation from "./StencilOperation.js";
  * @param {boolean} [options.debugShowBoundingVolume=false] For debugging only. Determines if this primitive's commands' bounding spheres are shown.
  * @param {boolean} [options.debugShowShadowVolume=false] For debugging only. Determines if the shadow volume for each geometry in the primitive is drawn. Must be <code>true</code> on
  *                  creation for the volumes to be created before the geometry is released or options.releaseGeometryInstance must be <code>false</code>.
- *
  * @see Primitive
  * @see GroundPrimitive
  * @see GeometryInstance

diff --git a/packages/engine/Source/Scene/GroundPolylinePrimitive.js b/packages/engine/Source/Scene/GroundPolylinePrimitive.js
@@ -45,7 +45,6 @@ import StencilOperation from "./StencilOperation.js";
  * @param {ClassificationType} [options.classificationType] Determines whether terrain, 3D Tiles or both will be classified.
  * @param {boolean} [options.debugShowBoundingVolume] For debugging only. Determines if this primitive's commands' bounding spheres are shown.
  * @param {boolean} [options.debugShowShadowVolume] For debugging only. Determines if the shadow volume for each geometry in the primitive is drawn. Must be <code>true</code> on creation to have effect.
- *
  * @example
  * // 1. Draw a polyline on terrain with a basic color material
  *

diff --git a/packages/engine/Source/Scene/GroundPrimitive.js b/packages/engine/Source/Scene/GroundPrimitive.js
@@ -62,7 +62,6 @@ const GroundPrimitiveUniformMap = {
  * @param {boolean} [options.debugShowBoundingVolume=false] For debugging only. Determines if this primitive's commands' bounding spheres are shown.
  * @param {boolean} [options.debugShowShadowVolume=false] For debugging only. Determines if the shadow volume for each geometry in the primitive is drawn. Must be <code>true</code> on
  *                  creation for the volumes to be created before the geometry is released or options.releaseGeometryInstance must be <code>false</code>.
- *
  * @example
  * // Example 1: Create primitive with a single instance
  * const rectangleInstance = new Cesium.GeometryInstance({
@@ -103,7 +102,6 @@ const GroundPrimitiveUniformMap = {
  * scene.primitives.add(new Cesium.GroundPrimitive({
  *   geometryInstances : [rectangleInstance, ellipseInstance]
  * }));
- *
  * @see Primitive
  * @see ClassificationPrimitive
  * @see GeometryInstance

diff --git a/packages/engine/Source/Scene/Material.js b/packages/engine/Source/Scene/Material.js
@@ -240,11 +240,8 @@ import WaterMaterial from "../Shaders/Materials/Water.js";
  * @throws {DeveloperError} strict: shader source does not use string.
  * @throws {DeveloperError} strict: shader source does not use uniform.
  * @throws {DeveloperError} strict: shader source does not use material.
- *
  * @see {@link https://github.com/CesiumGS/cesium/wiki/Fabric|Fabric wiki page} for a more detailed options of Fabric.
- *
  * @demo {@link https://sandcastle.cesium.com/index.html?src=Materials.html|Cesium Sandcastle Materials Demo}
- *
  * @example
  * // Create a color material with fromType:
  * polygon.material = Cesium.Material.fromType('Color');