doc: remove empty class used for documentation

Desplandis · mgermerie · commit 9479973d6a03 · 2024-09-17T10:44:00.000+02:00
diff --git 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
@@ -20,7 +20,7 @@
 <section>
 
 <article>
-<?js if (content.kind === 'class' || content.kind === 'module') { ?>
+<?js if (content.kind === 'class' || content.kind === 'module' || content.kind === 'typedef') { ?>
     <h1>
         <?js= content.name ?>
         <?js if (content.augments && content.augments.length) { ?>
diff --git 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
@@ -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.<br/>
+ * 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.<br/>
- * 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
@@ -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
@@ -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;
 

Original file line number	Diff line number	Diff line change
`@@ -47,12 +47,11 @@ class InformationsData {`
`47`	`47`	`}`
`48`	`48`	`}`
`49`	`49`	`/**`
`50`		`- * This class describes parsing options.`
	`50`	`+ * This interface describes parsing options.`
	`51`	`+ * @typedef {Object} ParsingOptions`
`51`	`52`	`* @property {InformationsData\|Source} in - data informations contained in the file.`
`52`	`53`	`* @property {FeatureBuildingOptions\|Layer} out - options indicates how the features should be built.`
`53`	`54`	`*/`
`54`		`-// eslint-disable-next-line`
`55`		`-class /* istanbul ignore next */ ParsingOptions {}`
`56`	`55`
`57`	`56`	`let uid = 0;`
`58`	`57`