docs(): add jsdoc to decorators

Author: wbhob

CHANGELOG.md

@@ -1,8 +1,3 @@
-<a name="1.0.0"></a>
-# [1.0.0](https://github.com/orbital-js/orbital/compare/v1.0.0-alpha.28...v1.0.0) (2018-06-27)
-
-
-
 <a name="1.0.0-alpha.28"></a>
 # [1.0.0-alpha.28](https://github.com/orbital-js/orbital/compare/v1.0.0-alpha.27...v1.0.0-alpha.28) (2018-06-27)
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "orbital",
-  "version": "1.0.0",
+  "version": "1.0.0-alpha.28",
   "description": "Typescript CLI framework for node",
   "scripts": {
     "start": "tsc",

packages/core/src/decorators/cli.ts

@@ -4,9 +4,22 @@ import { setClassMetadata } from '../reflection/class';
  * Configuration for the `CLI` decorator.
  */
 export interface CLIMetadata {
+
+    /**
+     * The `bin` name of the command, as it will be invoked by the user.
+     */
     name?: string;
+
+    /**
+     * A cleaner, properly capitalized version of your CLI.
+     */
     prettyName?: string;
+
+    /**
+     * The current version of your CLI package, as seen in package.json.
+     */
     version?: string;
+
     /**
      * import your commands and subcommand groups
      */

packages/core/src/decorators/option.ts

@@ -7,7 +7,6 @@ import { getType } from '../reflection/types';
 export interface OptionMetadata {
     name?: string;
     aliases?: string[];
-    brief?: string;
     description?: string;
 }
 

packages/core/src/decorators/param.ts

@@ -7,7 +7,6 @@ import { getParamNames } from '../util/param-name';
  */
 export interface ParamMetadata {
     name?: string;
-    brief?: string;
     required?: boolean;
     description?: string;
 }