adding short doc explanation for aw-feature directive

This commit is contained in:
Jared Tabor 2015-05-04 14:46:52 -04:00
parent 79b79f0481
commit 88d444ead7
2 changed files with 19 additions and 0 deletions

View File

@ -1,4 +1,22 @@
/**
* @ngdoc overview
* @name features
* @scope
* @description enables/disables features based on license
*
* @ngdoc directive
* @name features.directive:awFeature
* @description The aw-feature directive works by taking in a string
* that maps to a license feature, and removes that feature from the
* DOM if it is a feature not supported by the user's license.
* For example, adding `aw-feature="system-tracking"` will enable or disable
* the system tracking button based on the license configuration on the
* /config endpoint.
*
*
*/
import featureController from 'tower/shared/features/features.controller';
export default [ function() {
return {
restrict: 'A',

View File

@ -1,5 +1,6 @@
import awFeatureDirective from 'tower/shared/features/features.directive';
import FeaturesService from 'tower/shared/features/features.service';
export default
angular.module('features', [])
.directive('awFeature', awFeatureDirective)