docs(cosmic-proto): generate initial typedoc

Agoric · Dec 11, 2024 · c8ad417 · c8ad417
1 parent 159098b
commit c8ad417
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 5 deletions.
diff --git a/packages/cosmic-proto/src/address-hooks.js b/packages/cosmic-proto/src/address-hooks.js
@@ -1,8 +1,9 @@
 /**
- * @module address-hooks
- * @file This module provides functions for encoding and decoding address hooks
- *   which are comprised of a bech32 base address with an HTTP query string, all
- *   wrapped in a bech32 envelope.
+ * This module provides functions for encoding and decoding address hooks
+ * which are comprised of a bech32 base address with an HTTP query string, all
+ * wrapped in a bech32 envelope.
+ *
+ * @module address-hooks.js
  * @example
  *
  *     import {

diff --git a/packages/cosmic-proto/typedoc.json b/packages/cosmic-proto/typedoc.json
@@ -0,0 +1,9 @@
+{
+    "extends": [
+        "../../typedoc.base.json"
+    ],
+    "entryPoints": [
+        "src/*.js",
+	      "src/helpers.ts"
+    ]
+}
diff --git a/typedoc.json b/typedoc.json
@@ -3,7 +3,6 @@
     "packages/*"
   ],
   "exclude": [
-    "packages/cosmic-proto/"
   ],
   "name": "API documentation of Agoric SDK ",
   "entryPointStrategy": "packages",