TSDOC

Source: FullClass.ts

///<reference path="Interface.ts"/>
///<reference path="Callbacks.ts"/>

/**
 * @namespace pulsar
 */
/**
 * @namespace pulsar.tsdoc
 */
module pulsar.tsdoc
{
	export class FullClass implements  pulsar.tsdoc.IInterface
	{


		/**
		 * Class Description Title
		 * @implements pulsar.tsdoc.IInterface
		 * @class pulsar.tsdoc.FullClass
		 * @classdesc Class Description
		 * @param {string} type Param Description
		 * @param {any} data Param Description
		 */
		constructor(private type:string, private data?:any ){}

		/**
		 * PublicMethod Description
		 * @method pulsar.tsdoc.FullClass#publicMethod
		 * @returns {string}
		 */
		public publicMethod():string{ return "publicMethod()" }

		/**
		 * PublicMethodWithParams Description
		 * @method pulsar.tsdoc.FullClass#publicMethodWithParams
		 * @param {string} name Param Description
		 * @param {pulsar.tsdoc.FullClass} typedParam Param Description
		 * @returns {pulsar.tsdoc.FullClass} Returns description
		 */
		public publicMethodWithParams( name:string, typedParam:pulsar.tsdoc.FullClass ):pulsar.tsdoc.FullClass{ return null }

		/**
		 * PrivateMethod Description
		 * @private
		 * @method pulsar.tsdoc.FullClass#privateMethod
		 * @returns {string}
		 */
		private privateMethod():string{ return "privateMethod()" }

		/**
		 * PublicStaticMethod Description
		 * @method pulsar.tsdoc.FullClass.publicStaticMethod
		 * @returns {string}
		 */
		public static publicStaticMethod():string{ return "publicStaticMethod()" }

		/**
		 * PrivateStaticMethod Description
		 * @private
		 * @method pulsar.tsdoc.FullClass.privateStaticMethod
		 * @returns {string}
		 */
		private static privateStaticMethod():string{ return "privateMethod()" }


		/* INTERFACE IMPLEMENTATION */

		/**
		 * PublicProperty description
		 * @member {string} pulsar.tsdoc.FullClass#name
		 */
		public name:string;

		/**
		 * PrivateMethod Description
		 * @method pulsar.tsdoc.FullClass#methodToImplement
		 * @param {string} name Param Description
		 * @param {number} index Param Description
		 */
		public methodToImplement( name:string, index:number ):void{}


		/* PROPERTIES */

		/**
		 * PublicProperty description
		 * @member {string} pulsar.tsdoc.FullClass#publicProperty
		 */
		public publicProperty:string;

		/**
		 * PrivateProperty description
		 * @private
		 * @member {string} pulsar.tsdoc.FullClass#privateProperty
		 */
		private privateProperty:string;

		/**
		 * PublicStaticProperty description
		 * @member {string} pulsar.tsdoc.FullClass.publicStaticProperty
		 */
		public static publicStaticProperty:string;

		/**
		 * PrivateStaticProperty description
		 * @access private
		 * @member {string} pulsar.tsdoc.FullClass.privateStaticProperty
		 */
		private static privateStaticProperty:string;


		/* EVENTS */

		/**
		 * Event Description
		 * @event pulsar.tsdoc.FullClass.events:COMPLETE
		 */
		public static COMPLETE:string = "COMPLETE";


		/**
		 * Fire Mthod annotation Description
		 * @method pulsar.tsdoc.FullClass#fireEvent
		 * @fires pulsar.tsdoc.FullClass#COMPLETE
		 */
		public fireEvent( event:string ):void
		{
			//..
		}

        /* CALLBACK REFERENCE */
        /**
         * Typed Callback Parameter
         * @method pulsar.tsdoc.FullClass#callCallBack
         * @param {pulsar.tsdoc.ICallBack} cb Callback Param Description
         */
        public callCallBack( cb:pulsar.tsdoc.ICallBack):void
        {

        }

	}


}

TSDOC Copyright ©2013 pcasaubon.
Documentation generated by JSDoc 3.2.0 on Mon Aug 12 2013 15:46:32 GMT+0200 (CEST) using the TSDoc template.