Document directives with JSDoc (#320)

Signed-off-by: Juan Cruz Viotti <jviottidc@gmail.com>
This commit is contained in:
Juan Cruz Viotti 2016-04-13 15:36:52 -04:00
parent a874d4b808
commit 79c19ef341
2 changed files with 14 additions and 4 deletions

View File

@ -17,14 +17,19 @@
'use strict';
/**
* @summary ProgressButton directive
* @function
* @public
*
* @description
* This directive provides a button containing a progress bar inside.
* The button is styled by default as a primary button.
*
* Example:
* @returns {Object} directive
*
* @example
* <progress-button percentage="{{ 40 }}" striped>My Progress Button</progress-button>
*/
module.exports = function() {
return {
templateUrl: './browser/components/progress-button/templates/progress-button.tpl.html',

View File

@ -22,14 +22,19 @@ const os = require('os');
const nodeOpen = require('open');
/**
* @summary OsOpenExternal directive
* @function
* @public
*
* @description
* This directive provides an attribute to open an external
* resource with the default operating system action.
*
* Example:
* @returns {Object} directive
*
* @example
* <button os-open-external="https://resin.io">Resin.io</button>
*/
module.exports = function() {
return {
restrict: 'A',