exports & comments

foxglove · Sep 13, 2023 · 811f45e · 811f45e
1 parent 5d89e9c
commit 811f45e
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 2 deletions.
diff --git a/typescript/support/src/index.ts b/typescript/support/src/index.ts
@@ -1,5 +1,7 @@
+export * from "./decompressHandlers";
+export * from "./parseChannel";
+export * from "./parseFlatbufferSchema";
 export * from "./parseJsonSchema";
+export * from "./parseProtobufSchema";
 export * from "./protobufDefinitionsToDatatypes";
 export * from "./protobufDescriptors";
-export * from "./parseChannel";
-export * from "./decompressHandlers";
diff --git a/typescript/support/src/parseChannel.ts b/typescript/support/src/parseChannel.ts
@@ -64,7 +64,13 @@ function parsedDefinitionsToDatatypes(
   return datatypes;
 }
 
+/**
+ * Options to configure the behavior of {@link parseChannel}.
+ */
 export type ParseChannelOptions = {
+  /**
+   * Options to configure the behavior of {@link parseProtobufSchema}.
+   */
   protobuf?: ParseProtobufSchemaOptions;
 };
 

diff --git a/typescript/support/src/parseProtobufSchema.ts b/typescript/support/src/parseProtobufSchema.ts
@@ -4,6 +4,9 @@ import { FileDescriptorSet } from "@foxglove/protobufjs/ext/descriptor";
 import { protobufDefinitionsToDatatypes, stripLeadingDot } from "./protobufDefinitionsToDatatypes";
 import { MessageDefinitionMap } from "./types";
 
+/**
+ * Options to configure the behavior of {@link parseProtobufSchema}.
+ */
 export type ParseProtobufSchemaOptions = {
   /**
    * A function that will be called with the root type after parsing the FileDescriptorSet. Used by