added code documentation

guillermocorrea · May 20, 2018 · c28fd0d · c28fd0d
1 parent 59b0eea
commit c28fd0d
Show file tree

Hide file tree

Showing 3 changed files with 48 additions and 0 deletions.
diff --git a/dist/index.d.ts b/dist/index.d.ts
@@ -1,2 +1,18 @@
 /// <reference types="angular" />
+/**
+ * Component decorator.
+ * @param {angular.IComponentOptions} options - The component options.
+ *
+ * ### Example
+ *
+ * ```typescript
+ * import { Component } from 'angularjs-annotations';
+ *
+ * @Component({
+ *  controller: AppComponentController,
+ *  template: require('./app.component.html')
+ * })
+ * export class AppComponent implements ng.IComponentOptions {}
+ * ```
+ */
 export declare function Component(options: angular.IComponentOptions): Function;
diff --git a/dist/index.js b/dist/index.js
@@ -1,5 +1,21 @@
 "use strict";
 exports.__esModule = true;
+/**
+ * Component decorator.
+ * @param {angular.IComponentOptions} options - The component options.
+ *
+ * ### Example
+ *
+ * ```typescript
+ * import { Component } from 'angularjs-annotations';
+ *
+ * @Component({
+ *  controller: AppComponentController,
+ *  template: require('./app.component.html')
+ * })
+ * export class AppComponent implements ng.IComponentOptions {}
+ * ```
+ */
 function Component(options) {
     return function (target) {
         var ctor;

diff --git a/index.ts b/index.ts
@@ -1,3 +1,19 @@
+/**
+ * Component decorator.
+ * @param {angular.IComponentOptions} options - The component options.
+ *
+ * ### Example
+ *
+ * ```typescript
+ * import { Component } from 'angularjs-annotations';
+ *
+ * @Component({
+ *  controller: AppComponentController,
+ *  template: require('./app.component.html')
+ * })
+ * export class AppComponent implements ng.IComponentOptions {}
+ * ```
+ */
 export function Component(options: angular.IComponentOptions): Function {
     return <returnFunc extends Function>(target: returnFunc) => {
         var ctor: Function;