Better docs

src/command.ts

@@ -3,25 +3,33 @@ import { ArgumentError, HelpError } from "./error.ts";
 import { leftPad } from "./fmt.ts";
 
 export interface ArgumentOptions {
-  // If `flags` is set, the argument is passed
-  // as a named flag, e.g. `--name value`. Otherwise,
-  // the argument will be an anonymous positional
-  // argument.
+  /**
+   * If `flags` is set, the argument is passed
+   * as a named flag, e.g. `--name value`. Otherwise,
+   * the argument will be an anonymous positional
+   * argument.
+   */
   readonly flags: string[];
 
-  // A description to display in the generated
-  // help messages.
+  /**
+   * A description to display in the generated
+   * help messages.
+   */
   readonly description?: string;
 }
 
 export interface FlagOptions {
-  // A set of aliases for the flag's `name`. If
-  // any of the aliases, or `--{name}` are passed,
-  // the flag is set to true.
+  /**
+   * A set of aliases for the flag's `name`. If
+   * any of the aliases, or `--{name}` are passed,
+   * the flag is set to true.
+   */
   readonly aliases?: string[];
 
-  // A description to display in the generated
-  // help messages.
+  /**
+   * A description to display in the generated
+   * help messages.
+   */
   readonly description?: string;
 }
 

src/types.ts

@@ -1,5 +1,21 @@
+/**
+ * A parser that can read a single argument
+ * value.
+ *
+ * Implement this interface to provide parsers
+ * for custom argument types.
+ */
 export interface ArgumentType<T> {
+  /**
+   * Function which parses a single argument. If
+   * the parsing fails, this should throw an error.
+   */
   readonly parse: (raw: string) => T;
+
+  /**
+   * Type name to use when displaying help and
+   * error messages.
+   */
   readonly typeName: string;
 }