Merge pull request #15 from andstor/develop

Reformat class documentation due to duplicated mixin documentation
andstor · Mar 5, 2020 · e5eaf6c · e5eaf6c
2 parents 25538a1 + 63ffb6f
commit e5eaf6c
Show file tree

Hide file tree

Showing 5 changed files with 12 additions and 22 deletions.
diff --git a/src/VoxelLoader.js b/src/VoxelLoader.js
@@ -7,12 +7,10 @@ import { Color, BufferGeometry, MeshPhongMaterial, BoxGeometry, Vector3, Mesh, G
 import { LoaderFactory } from "./loaders/LoaderFactory";
 import { levelOfDetail } from './mixins/levelOfDetail';
 
-/**
- * Class for loading voxel data stored in various formats.
- */
 class VoxelLoader {
   /**
    * Create a VoxelLoader.
+   * @classdesc Class for loading voxel data stored in various formats.
    * @param {LoadingManager} manager
    * @mixes levelOfDetail
    */

diff --git a/src/loaders/ArrayLoader.js b/src/loaders/ArrayLoader.js
@@ -7,14 +7,12 @@ import { PointOctree } from "sparse-octree";
 import autoBind from 'auto-bind';
 import { levelOfDetail } from '../mixins/levelOfDetail';
 
-/**
- * Class for loading voxel data stored as a 3D array.
- * @extends Loader
- * @mixes levelOfDetail
- */
 class ArrayLoader extends Loader {
   /**
    * Create an ArrayLoader.
+   * @classdesc Class for loading voxel data stored as a 3D array.
+   * @extends Loader
+   * @mixes levelOfDetail
    * @param {LoadingManager} manager
    */
   constructor(manager) {

diff --git a/src/loaders/OctreeLoader.js b/src/loaders/OctreeLoader.js
@@ -6,13 +6,11 @@ import { PointOctree } from "sparse-octree";
 import autoBind from 'auto-bind';
 import { levelOfDetail } from "../mixins/levelOfDetail";
 
-/**
- * Class for loading voxel data stored in a PointOctree.
- * @mixes levelOfDetail
- */
 class OctreeLoader {
   /**
    * Create a OctreeLoader.
+   * @classdesc Class for loading voxel data stored in a PointOctree.
+   * @mixes levelOfDetail
    */
   constructor() {
     autoBind(this);

diff --git a/src/loaders/VOXLoader.js b/src/loaders/VOXLoader.js
@@ -9,14 +9,12 @@ import { VoxReader, VoxNodeTools, VoxTools } from '@sh-dave/format-vox';
 import { Vector4 } from 'math-ds';
 import { levelOfDetail } from '../mixins/levelOfDetail';
 
-/**
- * Class for loading voxel data stored in VOX files.
- * @extends Loader
- * @mixes levelOfDetail
- */
 class VOXLoader extends Loader {
   /**
    * Create a VOXLoader.
+   * @classdesc Class for loading voxel data stored in VOX files.
+   * @extends Loader
+   * @mixes levelOfDetail
    * @param {LoadingManager} manager
    */
   constructor(manager) {

diff --git a/src/loaders/XMLLoader.js b/src/loaders/XMLLoader.js
@@ -7,14 +7,12 @@ import { FileLoader, Loader, Vector3, LoadingManager } from 'three';
 import { PointOctree } from "sparse-octree";
 import { levelOfDetail } from '../mixins/levelOfDetail';
 
-/**
- * Class for loading voxel data stored in XML files.
- * @extends Loader
- * @mixes levelOfDetail
- */
 class XMLLoader extends Loader {
   /**
    * Create a XMLLoader.
+   * @classdesc Class for loading voxel data stored in XML files.
+   * @extends Loader
+   * @mixes levelOfDetail
    * @param {LoadingManager} manager
    */
   constructor(manager) {