add note

christo · Dec 21, 2024 · 5c92d13 · 5c92d13
1 parent 2c75a5e
commit 5c92d13
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/client/src/machine/asm/DisassemblyMetaImpl.ts b/client/src/machine/asm/DisassemblyMetaImpl.ts
@@ -54,6 +54,11 @@ class DisassemblyMetaImpl implements DisassemblyMeta {
     this.symbolResolver = symbolResolver;
   }
 
+  /**
+   * Read the absolute base address from the given {@link FileBlob} using configured offset.
+   * FUTURE: assumes base load address is present in fb
+   * @param fb the FileBlob
+   */
   baseAddress(fb: FileBlob): number {
     return fb.read16(this._baseAddressOffset);
   }