diff --git a/docs/publish.js b/docs/publish.js index 67c31bf1b7..054cb80954 100644 --- a/docs/publish.js +++ b/docs/publish.js @@ -66,7 +66,7 @@ function sortByPackage(members, navList) { for (const type in members) { const member = members[type]; - if (!member || type == 'globals' || type == 'tutorials') { continue; } + if (!member || type == 'tutorials') { continue; } member.forEach((m) => { const p = invertedNavList[m.name] || invertedNavList[m.memberof]; if (!p) { return; } diff --git a/docs/tmpl/page.tmpl b/docs/tmpl/page.tmpl index a25f86de41..bbd174ff14 100644 --- a/docs/tmpl/page.tmpl +++ b/docs/tmpl/page.tmpl @@ -20,7 +20,7 @@
- +

diff --git a/src/Core/Feature.js b/src/Core/Feature.js index 197572b859..3dd84d3014 100644 --- a/src/Core/Feature.js +++ b/src/Core/Feature.js @@ -31,6 +31,7 @@ export const FEATURE_TYPES = { }; /** + * @typedef {Object} FeatureBuildingOptions * @property {string} crs - The CRS to convert the input coordinates to. * @property {string} [structure='2d'] - data structure type : 2d or 3d. * If the structure is 3d, the feature have 3 dimensions by vertices positions and @@ -47,8 +48,7 @@ export const FEATURE_TYPES = { * @property {Style} style - The style to inherit when creating * style for all new features. * -*/ -export class FeatureBuildingOptions {} + */ /** * @property {Extent} extent - The 2D extent containing all the points diff --git a/src/Core/Style.js b/src/Core/Style.js index a1234c8f40..49429a4664 100644 --- a/src/Core/Style.js +++ b/src/Core/Style.js @@ -299,8 +299,11 @@ function _addIcon(icon, domElement, opt) { } /** + * An object that can contain any properties (order, zoom, fill, stroke, point, + * text or/and icon) and sub properties of a Style.
+ * Used for the instanciation of a {@link Style}. + * * @typedef {Object} StyleOptions - * @memberof StyleOptions * * @property {Number} [order] - Order of the features that will be associated to * the style. It can helps sorting and prioritizing features if needed. @@ -442,15 +445,6 @@ function _addIcon(icon, domElement, opt) { * `0.0` and `1.0`. Default is `1.0`. */ -/** - * @description An object that can contain any properties - * (order, zoom, fill, stroke, point, text or/and icon) - * and sub properties of a Style.
- * Used for the instanciation of a {@link Style}. - * @hideconstructor - */ -export class StyleOptions {} - /** * @class * @classdesc A Style is a class that defines the visual appearance of {@link diff --git a/src/Renderer/PointsMaterial.js b/src/Renderer/PointsMaterial.js index 14bc495c52..ff57a2ac27 100644 --- a/src/Renderer/PointsMaterial.js +++ b/src/Renderer/PointsMaterial.js @@ -36,14 +36,13 @@ const white = new THREE.Color(1.0, 1.0, 1.0); * top of canopy, and water. The different classes are defined using numeric * integer codes in the files. * + * @typedef {Object} Classification * @property {object} category - category classification, * @property {boolean} category.visible - category visibility, * @property {string} category.name - category name, * @property {THREE.Color} category.color - category color, * @property {number} category.opacity - category opacity, */ -// eslint-disable-next-line -class /* istanbul ignore next */ Classification {} export const ClassificationScheme = { DEFAULT: { diff --git a/src/Source/Source.js b/src/Source/Source.js index feadfa8c5c..b4ea539160 100644 --- a/src/Source/Source.js +++ b/src/Source/Source.js @@ -47,12 +47,11 @@ class InformationsData { } } /** - * This class describes parsing options. + * This interface describes parsing options. + * @typedef {Object} ParsingOptions * @property {InformationsData|Source} in - data informations contained in the file. * @property {FeatureBuildingOptions|Layer} out - options indicates how the features should be built. */ -// eslint-disable-next-line -class /* istanbul ignore next */ ParsingOptions {} let uid = 0;