Inicio Explorar Axuda
Rexistro Iniciar sesión
bin
/
tourism-wxapp
1
0
Fork 0
Ficheiros Incidencias 0 Pull Requests 0 Wiki
Árbore: 66f00d63c9
Ramas Etiquetas
tourism-wxapp
/
node_modules
/
foodoc
/
test-src
/
namespaced
/
MyApi.js

MyApi.js 6.5 KB
Histórico Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165 
  1. /**
    2. 

  2.  * @summary This is the test summary for the `MyApi` namespace.
    3. 

  3.  * @namespace MyApi
    4. 

  4.  * @description This is the longer description for the namespace giving a better idea about the code contained within it.
    5. 

  5.  */
    6. 

  6. window.MyApi = {
    7. 

  7. 	/**
    8. 

  8. 	 * @summary This is a static member of the namespace.
    9. 

  9. 	 * @memberof MyApi.
    10. 

  10. 	 * @name staticMember
    11. 

  11. 	 * @type {string}
    12. 

  12. 	 * @default I'm a member of the MyApi namespace.
    13. 

  13. 	 */
    14. 

  14. 	staticMember: "I'm a member of the MyApi namespace."
    15. 

  15. };
    16. 

  16. 

  17. /**
    18. 

  18.  * @summary This is a test type definition on the MyApi namespace.
    19. 

  19.  * @memberof MyApi~
    20. 

  20.  * @typedef {Object} Object
    21. 

  21.  * @prop {string} name - This is the name of the test object.
    22. 

  22.  * @prop {boolean} [enabled=false] - This is whether or not the test object is enabled. Defaults to `false`.
    23. 

  23.  */
    24. 

  24. 

  25. /**
    26. 

  26.  * @summary This is the summary of the MyApi test class, test `markdown`.
    27. 

  27.  * @memberof MyApi
    28. 

  28.  * @constructor Class
    29. 

  29.  * @param {string} arg1 - The first test arg, test `markdown`.
    30. 

  30.  * @param {...string} [arg2=false] - A repeatable, optional argument with a default value of false, test `markdown`.
    31. 

  31.  * @description This is the description for the class this is meant to be a more in depth explanation of what this class does and it's general use case, test `markdown`
    32. 

  32.  * @example {@caption You can provide example captions with `markdown` and specify the language to use when rendering the code, defaults to `javascript`.}
    33. 

  33.  * var gc = new GlobalClass("arg1", "arg2");
    34. 

  34.  * @example {@lang xml}
    35. 

  35.  * <head>
    36. 

  36.  * 	<title>HTML Highlighting</title>
    37. 

  37.  * 	<script>
    38. 

  38.  * 	  // supports embedded languages
    39. 

  39.  * 		var gc = new GlobalClass("arg1", "arg2");
    40. 

  40.  * 	</script>
    41. 

  41.  * </head>
    42. 

  42.  */
    43. 

  43. MyApi.Class = function(arg1, arg2){
    44. 

  44. 	/**
    45. 

  45. 	 * @summary I'm a member of the class.
    46. 

  46. 	 * @memberof MyApi.Class#
    47. 

  47. 	 * @name publicMember
    48. 

  48. 	 * @type {string}
    49. 

  49. 	 * @default "I'm an instance member."
    50. 

  50. 	 */
    51. 

  51. 	this.publicMember = "I'm an instance member.";
    52. 

  52. 	/**
    53. 

  53. 	 * @summary I'm a protected member of the class.
    54. 

  54. 	 * @memberof MyApi.Class#
    55. 

  55. 	 * @name protectedMember
    56. 

  56. 	 * @type {string}
    57. 

  57. 	 * @default "I'm a protected member."
    58. 

  58. 	 * @protected
    59. 

  59. 	 */
    60. 

  60. 	this.protectedMember = "I'm a protected member.";
    61. 

  61. 	/**
    62. 

  62. 	 * @summary I'm a private member of the class.
    63. 

  63. 	 * @memberof MyApi.Class#
    64. 

  64. 	 * @name _privateMember
    65. 

  65. 	 * @type {string}
    66. 

  66. 	 * @default "I'm a private member."
    67. 

  67. 	 * @private
    68. 

  68. 	 */
    69. 

  69. 	this._privateMember = "I'm a private member.";
    70. 

  70. };
    71. 

  71. 

  72. /**
    73. 

  73.  * @summary This is a test instance method of the MyApi test class, test `markdown`.
    74. 

  74.  * @memberof MyApi.Class#
    75. 

  75.  * @function testMethod
    76. 

  76.  * @param {*} value - Any value, test `markdown`
    77. 

  77.  * @param {Object} obj - The first object of what could be many, test `markdown`
    78. 

  78.  * @param {...Object} [objN] - Any additional objects, test `markdown`
    79. 

  79.  * @returns {Object} The combination of all the objects, test `markdown`.
    80. 

  80.  * @description This method is not overridden in the {@link MyApi.Child} class but is simply inherited.
    81. 

  81.  * @fires MyApi.Class~"test.my-api"
    82. 

  82.  * @throws {CustomError} This is thrown when some condition fails within this method.
    83. 

  83.  */
    84. 

  84. MyApi.Class.prototype.testMethod = function(value, obj, objN){
    85. 

  85. 	/**
    86. 

  86. 	 * @summary This is an event raised by this class, it's documentation appears on this page as the event is specified as an inner member the class by using the tilde (~) scope.
    87. 

  87. 	 * @memberof MyApi.Class~
    88. 

  88. 	 * @event "test.my-api"
    89. 

  89. 	 * @param {Event} e - The event object.
    90. 

  90. 	 * @param {*} custom - Some custom parameter passed to any listeners.
    91. 

  91. 	 */
    92. 

  92. 	throw new CustomError("Some custom error.");
    93. 

  93. };
    94. 

  94. 

  95. /**
    96. 

  96.  * @summary This is a another test instance method of the MyApi test class, test `markdown`.
    97. 

  97.  * @memberof MyApi.Class#
    98. 

  98.  * @function anotherMethod
    99. 

  99.  * @param {*} value - Any value, test `markdown`
    100. 

  100.  * @param {Object} obj - The first object of what could be many, test `markdown`
    101. 

  101.  * @param {...Object} [objN] - Any additional objects, test `markdown`
    102. 

  102.  * @returns {Object} The combination of all the objects, test `markdown`.
    103. 

  103.  * @description This method is overridden in the {@link MyApi.Child} class and should remove the exception documentation as it no longer applies.
    104. 

  104.  * @fires MyApi.Class~"another.my-api"
    105. 

  105.  * @throws {CustomError} This is thrown when some condition fails within this method.
    106. 

  106.  */
    107. 

  107. MyApi.Class.prototype.anotherMethod = function(value, obj, objN){
    108. 

  108. 	/**
    109. 

  109. 	 * @summary This is an event raised by this class, it's documentation appears on this page as the event is specified as an inner member the class by using the tilde (~) scope.
    110. 

  110. 	 * @memberof MyApi.Class~
    111. 

  111. 	 * @event "another.my-api"
    112. 

  112. 	 * @param {Event} e - The event object.
    113. 

  113. 	 * @param {*} custom - Some custom parameter passed to any listeners.
    114. 

  114. 	 */
    115. 

  115. };
    116. 

  116. 

  117. /**
    118. 

  118.  * @summary This is a test type definition on the MyApi.Class class.
    119. 

  119.  * @memberof MyApi.Class~
    120. 

  120.  * @typedef {Object} Object
    121. 

  121.  * @prop {string} name - The name of the test object.
    122. 

  122.  * @prop {boolean} [enabled=false] - Whether or not the test object is enabled. Defaults to `false`.
    123. 

  123.  * @prop {Object} sub - An object containing a subset of properties.
    124. 

  124.  * @prop {number} sub.id - The subset id.
    125. 

  125.  * @prop {boolean} [sub.name="Sub Options"] - The name of the sub object. Defaults to `"Sub Options"`.
    126. 

  126.  */
    127. 

  127. 

  128. /**
    129. 

  129.  * @summary This is the summary of the MyApi child class, test `markdown`.
    130. 

  130.  * @memberof MyApi
    131. 

  131.  * @constructor Child
    132. 

  132.  * @extends MyApi.Class
    133. 

  133.  */
    134. 

  134. MyApi.Child = function(){
    135. 

  135. 	/**
    136. 

  136. 	 * @summary I'm a protected member of the class.
    137. 

  137. 	 * @memberof MyApi.Child#
    138. 

  138. 	 * @name protectedMember
    139. 

  139. 	 * @type {string}
    140. 

  140. 	 * @default "I'm a protected member."
    141. 

  141. 	 * @protected
    142. 

  142. 	 */
    143. 

  143. 	this.protectedMember = "I'm a protected member.";
    144. 

  144. };
    145. 

  145. 

  146. /**
    147. 

  147.  * @summary This is a another test instance method of the MyApi child class, test `markdown`.
    148. 

  148.  * @memberof MyApi.Child#
    149. 

  149.  * @function anotherMethod
    150. 

  150.  * @param {*} value - Any value, test `markdown`
    151. 

  151.  * @param {Object} obj - The first object of what could be many, test `markdown`
    152. 

  152.  * @param {...Object} [objN] - Any additional objects, test `markdown`
    153. 

  153.  * @returns {Object} The combination of all the objects, test `markdown`.
    154. 

  154.  * @description This method overrides the {@link MyApi.Class#anotherMethod} and should remove the exception documentation as it no longer applies. The event should also be updated to reflect it is raised by this class and not the inherited one.
    155. 

  155.  * @fires MyApi.Child~"another.my-api"
    156. 

  156.  */
    157. 

  157. MyApi.Child.prototype.anotherMethod = function(value, obj, objN){
    158. 

  158. 	/**
    159. 

  159. 	 * @summary This is an event raised by this class, it's documentation appears on this page as the event is specified as an inner member the class by using the tilde (~) scope.
    160. 

  160. 	 * @memberof MyApi.Child~
    161. 

  161. 	 * @event "another.my-api"
    162. 

  162. 	 * @param {Event} e - The event object.
    163. 

  163. 	 * @param {*} custom - Some custom parameter passed to any listeners.
    164. 

  164. 	 */
    165. 

  165. };
    166.