build: generate links to source code in documentation

dfinity · Jul 2, 2023 · f3c2e5c · f3c2e5c
1 parent 9b1784e
commit f3c2e5c
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 8 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -55,7 +55,7 @@
     "text-encoding": "^0.7.0",
     "ts-jest": "^29.1.0",
     "ts-protoc-gen": "^0.15.0",
-    "tsdoc-markdown": "^0.0.1",
+    "tsdoc-markdown": "^0.0.2",
     "typescript": "^4.9.5",
     "whatwg-fetch": "^3.6.2"
   },

diff --git a/packages/ledger/src/utils/payment.utils.ts b/packages/ledger/src/utils/payment.utils.ts
@@ -9,12 +9,14 @@ import { isNullish, nonNullish } from "@dfinity/utils";
  * Please note that this function doesn't perform any validity checks on the extracted information.
  * It does not verify if the token is known or if the identifier is a valid address.
  *
+ * ```
  * urn            = token ":" address [ "?" params]
  * token         = [ ckbtc / icp / chat / bitcoin / ethereum ... ]
  * address       = STRING
  * params        = param [ "&" params ]
  * param         = [ amountparam ]
  * amountparam   = "amount=" *digit [ "." *digit ]
+ * ``
  *
  * @param code string
  * @returns { token: string; identifier: string; amount?: number } | undefined