docs: improve start() docs

paradoxuum · Jul 30, 2024 · 1fe6b4f · 1fe6b4f
1 parent ccef92f
commit 1fe6b4f
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git a/packages/core/src/client/core.ts b/packages/core/src/client/core.ts
@@ -55,9 +55,9 @@ export class CenturionClient {
 	}
 
 	/**
-	 * Starts {@link CenturionClient}.
+	 * Starts {@link CenturionServer}.
 	 *
-	 * @param callback The run callback.
+	 * @param callback A callback that is called after the registry has been initialized.
 	 */
 	async start(callback?: (registry: ClientRegistry) => void) {
 		this.logger.assert(!this.started, "Centurion has already been started");

diff --git a/packages/core/src/server/core.ts b/packages/core/src/server/core.ts
@@ -52,6 +52,8 @@ export class CenturionServer {
 
 	/**
 	 * Starts {@link CenturionServer}.
+	 *
+	 * @param callback A callback that is called after the registry has been initialized.
 	 */
 	async start(callback?: (registry: ServerRegistry) => void) {
 		this.logger.assert(!this.started, "Centurion has already been started");