You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Currently, we have two different approaches to documenting arrays in Cesium.
Mark the type as an Array, i.e. @param {Array} vertices The vertices
Mark the type with array notation, i.e. @param {Number[]} vertices The vertices
@kring proposed that we move exclusively to the second approach because it will correctly generate a link to the Cesium documentation if it's a Cesium type. I agree with him. Unless anyone has any objections, we should make this change throughout the codebase. It should be easy as searching for {Array} and then determine the type and update the doc.
The text was updated successfully, but these errors were encountered:
/** * Computes an instance of an AxisAlignedBoundingBox. The box is determined by * finding the points spaced the farthest apart on the x, y, and z axes. * @memberof AxisAlignedBoundingBox * * @param {Array} positions List of points that the bounding box will enclose. Each point must have a <code>x</code>, <code>y</code>, and <code>z</code> properties. * (...) */AxisAlignedBoundingBox.fromPoints=function(positions,result){if(!defined(result)){result=newAxisAlignedBoundingBox();}if(!defined(positions)||positions.length===0){result.minimum=Cartesian3.clone(Cartesian3.ZERO,result.minimum);result.maximum=Cartesian3.clone(Cartesian3.ZERO,result.maximum);result.center=Cartesian3.clone(Cartesian3.ZERO,result.center);returnresult;}(codegoeson...)};
I think it is an array of Cartesian3 so should I replace {Array} with {Cartesian3[]} in this case?
Currently, we have two different approaches to documenting arrays in Cesium.
@param {Array} vertices The vertices
@param {Number[]} vertices The vertices
@kring proposed that we move exclusively to the second approach because it will correctly generate a link to the Cesium documentation if it's a Cesium type. I agree with him. Unless anyone has any objections, we should make this change throughout the codebase. It should be easy as searching for
{Array}
and then determine the type and update the doc.The text was updated successfully, but these errors were encountered: