Skip to content

Commit

Permalink
doc: remove empty class used for documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Desplandis authored and mgermerie committed Sep 17, 2024
1 parent 29dfc60 commit 9479973
Show file tree
Hide file tree
Showing 6 changed files with 11 additions and 19 deletions.
2 changes: 1 addition & 1 deletion docs/publish.js
Original file line number Diff line number Diff line change
Expand Up @@ -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; }
Expand Down
2 changes: 1 addition & 1 deletion docs/tmpl/page.tmpl
Original file line number Diff line number Diff line change
Expand Up @@ -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) { ?>
Expand Down
4 changes: 2 additions & 2 deletions src/Core/Feature.js
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down
14 changes: 4 additions & 10 deletions src/Core/Style.js
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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
Expand Down
3 changes: 1 addition & 2 deletions src/Renderer/PointsMaterial.js
Original file line number Diff line number Diff line change
Expand Up @@ -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: {
Expand Down
5 changes: 2 additions & 3 deletions src/Source/Source.js
Original file line number Diff line number Diff line change
Expand Up @@ -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;

Expand Down

0 comments on commit 9479973

Please sign in to comment.