mirror of
https://github.com/balena-io/etcher.git
synced 2025-07-21 18:26:32 +00:00
Document directives with JSDoc (#320)
Signed-off-by: Juan Cruz Viotti <jviottidc@gmail.com>
This commit is contained in:
parent
a874d4b808
commit
79c19ef341
@ -17,14 +17,19 @@
|
|||||||
'use strict';
|
'use strict';
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
* @summary ProgressButton directive
|
||||||
|
* @function
|
||||||
|
* @public
|
||||||
|
*
|
||||||
|
* @description
|
||||||
* This directive provides a button containing a progress bar inside.
|
* This directive provides a button containing a progress bar inside.
|
||||||
* The button is styled by default as a primary button.
|
* 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>
|
* <progress-button percentage="{{ 40 }}" striped>My Progress Button</progress-button>
|
||||||
*/
|
*/
|
||||||
|
|
||||||
module.exports = function() {
|
module.exports = function() {
|
||||||
return {
|
return {
|
||||||
templateUrl: './browser/components/progress-button/templates/progress-button.tpl.html',
|
templateUrl: './browser/components/progress-button/templates/progress-button.tpl.html',
|
||||||
|
@ -22,14 +22,19 @@ const os = require('os');
|
|||||||
const nodeOpen = require('open');
|
const nodeOpen = require('open');
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
* @summary OsOpenExternal directive
|
||||||
|
* @function
|
||||||
|
* @public
|
||||||
|
*
|
||||||
|
* @description
|
||||||
* This directive provides an attribute to open an external
|
* This directive provides an attribute to open an external
|
||||||
* resource with the default operating system action.
|
* resource with the default operating system action.
|
||||||
*
|
*
|
||||||
* Example:
|
* @returns {Object} directive
|
||||||
*
|
*
|
||||||
|
* @example
|
||||||
* <button os-open-external="https://resin.io">Resin.io</button>
|
* <button os-open-external="https://resin.io">Resin.io</button>
|
||||||
*/
|
*/
|
||||||
|
|
||||||
module.exports = function() {
|
module.exports = function() {
|
||||||
return {
|
return {
|
||||||
restrict: 'A',
|
restrict: 'A',
|
||||||
|
Loading…
x
Reference in New Issue
Block a user