docs(agents): Add some missing tsdocs

regal · Aug 29, 2019 · dd43e60 · dd43e60
1 parent 29a0024
commit dd43e60
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/src/agents/agent-manager.ts b/src/agents/agent-manager.ts
@@ -66,6 +66,10 @@ export interface AgentManager {
      */
     deleteProperty(property: PropertyKey): void;
 
+    /**
+     * Sets the agent manager's `AgentProtoId`
+     * @param protoId The prototype id
+     */
     setProtoId(protoId: FK<AgentProtoId>): void;
 }
 

diff --git a/src/agents/agent-meta.ts b/src/agents/agent-meta.ts
@@ -8,7 +8,9 @@
 import { PK } from "../common";
 import { Agent } from "./agent";
 
+/** Type alias for `Agent` primary key. */
 export type AgentId = PK<Agent>;
+/** Type alias for `Agent` prototype primary key. */
 export type AgentProtoId = PK<"AgentProto">;
 
 /**