suh-dgeni-ngdocs/app.min.js

A package to generate ng-docs similar to what is used on AngularJS website.

/** 
 * @ngdoc overview
 * @name HomePage
 * @module Test
 * @description 
 * home page text goes here
 *
 */

/**
 * @ngdoc module
 * @name Test
 * @module Test
 * @angular angular 1.3.15
 * @requires ngAnimate
 * @requires ngTouch
 * @note this is just a test
 * @note {danger} this is just a test
 * @installation 
 * to install through NPM 
 * ```sh
 *   npm install suh-dgeni-ngdocs --save-dev
 *
 * ```
 * @briefdesc
 * This is a test module used to check if the library is working fine. {@note primary <important> This is nice.} 
 * @description 
 * This is just a test module {@note primary <important> This is nice.} 
 * @todo {urgent} {note} This is a nice place
 * @todo This is not good
 * @todo {urgent} This is a nice place
 */

angular.module('TestModule',[]);

/**
 * @ngdoc service
 * @name Gulp
 * @module Test
 * @requires Jake
 * @description 
 * this is a good service
 * @example
 <example module="Suhail" deps="app.min.js" fixBase="true" name="gulp-example">
<file name="index.html">
  <div class="container" >
    <div ng-bind="i18n.kick_boxing" suh-lang-group="kick.throw" sh-translation="kick.boxing" ng-attr-title="{{i18n.kick_boxing}}" ng-attr-cx="{{i18n.kick_throw}}">
    </div>
    <div ng-controller="TestCtrl as ctrl" >
      <button ng-click="ctrl.switchLanguage()">Switch</button>
    </div> 
  </div>
</file>
<file name="script.js">
  angular.module('Suhail',['TestModule']);
    angular.module('Suhail')
      .controller('TestCtrl', ['$scope', function ($S) {
        var langs = ['en-GB','ar-SA'];
        this.switchLanguage = function(){
          langs.push(langs.shift());
          console.log('hey');
        };
      }])
</file>
</example>
 */
 function Gulp(){
 	/**
   * @ngdoc method
   * @name Gulp#getMe
   * @methodOf Gulp
   * @module Test
   * @param {string} id the identifier of the method
   * @todo {urget} fix this
   * @description This is a good method
   */

   /**
   * @ngdoc method
   * @name Gulp#getMeOkay
   * @methodOf Gulp
   * @module Test
   * @param {string} id the identifier of the method
   * @todo {urgent} fix this
   * @note {urgent} testinging asdf asfas fasd as fasd fas fas fasdf
   * @description This is a good method
   */
 }

 /**
  * @ngdoc directive
  * @name Dog
  * @module Test
  * @description 
  * This is just a test directive
  * @example
<example module="Suhail" deps="app.min.js" fixBase="true" name="gulp-example">
<file name="index.html">
  <div class="container" >
    <div ng-bind="i18n.kick_boxing" suh-lang-group="kick.throw" sh-translation="kick.boxing" ng-attr-title="{{i18n.kick_boxing}}" ng-attr-cx="{{i18n.kick_throw}}">
    </div>
    <div ng-controller="TestCtrl as ctrl" >
      <button ng-click="ctrl.switchLanguage()">Switch</button>
    </div> 
  </div>
</file>
<file name="script.js">
  angular.module('Suhail',['TestModule']);
    angular.module('Suhail')
      .controller('TestCtrl', ['$scope', function ($S) {
        var langs = ['en-GB','ar-SA'];
        this.switchLanguage = function(){
          langs.push(langs.shift());
          console.log('hey');
        };
      }])
</file>
</example>
  * @briefdesc 
  * A good description
  * @todo {important} good to go
  */

/**
 * @ngdoc service
 * @name Jake
 * @implements Suhail
 * @module Test
 * @description just another test service
 */

 /**
  * @ngdoc interface
  * @name Suhail
  * @module Test
  * @description Okay
  *
  *
  */