Skip to content

Commit f8ebec6

Browse files
committed
chore: small typedoc format corrections
1 parent 7496f56 commit f8ebec6

File tree

4 files changed

+4
-27
lines changed

4 files changed

+4
-27
lines changed

packages/fragments/src/FragmentsModels/index.ts

Lines changed: 1 addition & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -9,16 +9,7 @@ import { Event } from "../Utils";
99
export * from "./src";
1010

1111
/**
12-
* The main class for managing multiple 3D models loaded from fragments files.
13-
* Handles loading, disposing, updating, raycasting, highlighting and coordinating multiple FragmentsModel instances.
14-
*
15-
* This class acts as the main entry point for working with fragments models. It:
16-
* - Manages loading and disposing of models
17-
* - Coordinates updates across all loaded models
18-
* - Handles raycasting and hit testing
19-
* - Manages highlighting across models
20-
* - Handles base coordinate systems
21-
*
12+
* The main class for managing multiple 3D models loaded from fragments files. Handles loading, disposing, updating, raycasting, highlighting and coordinating multiple FragmentsModel instances. This class acts as the main entry point for working with fragments models.
2213
*/
2314
export class FragmentsModels {
2415
/**

packages/fragments/src/FragmentsModels/src/model/fragments-model.ts

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -38,14 +38,7 @@ import { DataManager } from "./data-manager";
3838
import { SequenceManager } from "./sequence-manager";
3939

4040
/**
41-
* The main class for managing a 3D model loaded from a fragments file.
42-
* Handles geometry, materials, visibility, highlighting, sections, and more.
43-
*
44-
* This class orchestrates multiple specialized managers to handle different aspects
45-
* of the model like mesh management, item data, raycasting, etc. It maintains the
46-
* overall state and provides the main interface for interacting with the model.
47-
*
48-
* The model data is loaded and processed asynchronously across multiple threads.
41+
* The main class for managing a 3D model loaded from a fragments file. Handles geometry, materials, visibility, highlighting, sections, and more. This class orchestrates multiple specialized managers to handle different aspects of the model like mesh management, item data, raycasting, etc. It maintains the overall state and provides the main interface for interacting with the model. The model data is loaded and processed asynchronously across multiple threads.
4942
*/
5043
export class FragmentsModel {
5144
/**

packages/fragments/src/FragmentsModels/src/model/model-types.ts

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -69,8 +69,7 @@ export interface RelsModifyChange {
6969
export type RelsChange = RelsModifyChange;
7070

7171
/**
72-
* Type representing a unique identifier for a model item.
73-
* This can be either a string or a number.
72+
* Type representing a unique identifier for a model item. This can be either a string or a number.
7473
*/
7574
export type Identifier = string | number;
7675

packages/fragments/src/Utils/flatbuffers-json-converter.ts

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,5 @@
11
/**
2-
* Recursively converts a Flatbuffers object into a plain JavaScript object.
3-
* This function traverses the prototype chain of the Flatbuffers object and extracts all properties
4-
* and their values, handling both primitive values and nested objects/arrays.
5-
*
6-
* @param obj - The Flatbuffers object to convert
7-
* @param result - The target plain JavaScript object where the converted properties will be stored
8-
*
2+
* Recursively converts a Flatbuffers object into a plain JavaScript object. This function traverses the prototype chain of the Flatbuffers object and extracts all properties and their values, handling both primitive values and nested objects/arrays.
93
*/
104
export function getObject(obj: any, result: any) {
115
const proto = Object.getPrototypeOf(obj);

0 commit comments

Comments
 (0)