torqueScriptReference-layout.xml 7.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219
  1. <doxygenlayout version="1.0">
  2. <!-- Generated by doxygen 1.8.3.1 -->
  3. <!-- Navigation index tabs for HTML output -->
  4. <navindex>
  5. <tab type="mainpage" visible="yes" title=""/>
  6. <tab type="pages" visible="yes" title="" intro=""/>
  7. <tab type="modules" visible="yes" title="" intro=""/>
  8. <!-- T2D: we are hiding the "real" Namespaces tab. See notes in our "fake" Namespaces tab below.
  9. If we could, we'd rename the concept of "Namespace" to "Functions" to get what we want.
  10. Instead we have simply made invisible all namespace-related tabs so they won't show
  11. in any cross-references.
  12. -->
  13. <tab type="namespaces" visible="no" title="Namespaces">
  14. <tab type="namespacelist" visible="no" title="Functions by Category" intro="A list of all functions organized by category"/>
  15. <tab type="namespacemembers" visible="no" title="All Function" intro="A list of all functions from all categories"/>
  16. </tab>
  17. <!-- We are making a global functions page. Global functions are actually functions
  18. in the pseudo-namespace "Functions".
  19. -->
  20. <tab type="user" title="Functions" url="namespaceFunctions.html"/>
  21. <!-- T2D: we are hiding the "real" Classes tab. See notes in our "fake" Classes tab below -->
  22. <tab type="classes" visible="no" title="">
  23. <tab type="classindex" visible="$ALPHABETICAL_INDEX" title="Classes A-Z"/>
  24. <tab type="hierarchy" visible="yes" title="Classes Hierarchy"/>
  25. <tab type="classlist" visible="no" title="" intro=""/>
  26. <tab type="classmembers" visible="no" title="" intro=""/>
  27. </tab>
  28. <!-- T2D: note that we made invisible the *real* "Classes" tab and then made our own.
  29. The reason is that the real Classes tab defaults to the "Class List" sub tab, which
  30. we don't want (more below).
  31. So why not just turn off the "classlist" tab so it doesn't show by default? Tried it, but
  32. doxygen shows that tab by default anyway. Even though it is "invisible" in the index.
  33. Why do we want to hide the class list tab anyway? It shows classes within namespaces.
  34. Since we are using namespaces to hide our TorqueScript classes/functions from the related
  35. Torque2D classes/functions (using namespaces "Functions" and "Class"), this list of classes
  36. in namespaces looked confusing.
  37. -->
  38. <tab type="usergroup" title="Classes">
  39. <tab type="user" url="classes.html" title="Classes A-Z"/>
  40. <tab type="user" url="hierarchy.html" title="Classes Hierarchy"/>
  41. </tab>
  42. <tab type="files" visible="yes" title="">
  43. <tab type="filelist" visible="yes" title="" intro=""/>
  44. <tab type="globals" visible="yes" title="" intro=""/>
  45. </tab>
  46. <tab type="examples" visible="yes" title="" intro=""/>
  47. </navindex>
  48. <!-- Layout definition for a class page -->
  49. <class>
  50. <briefdescription visible="yes"/>
  51. <includes visible="$SHOW_INCLUDE_FILES"/>
  52. <inheritancegraph visible="$CLASS_GRAPH"/>
  53. <collaborationgraph visible="$COLLABORATION_GRAPH"/>
  54. <memberdecl>
  55. <nestedclasses visible="yes" title=""/>
  56. <publictypes title=""/>
  57. <publicslots title=""/>
  58. <signals title=""/>
  59. <!-- T2D: rename "Public Methods Function" to be just "Methods" for TorqueScript -->
  60. <publicmethods title="Methods"/>
  61. <publicstaticmethods title=""/>
  62. <!-- T2D: rename "Public Attributes" to be just "Fields" for TorqueScript -->
  63. <publicattributes title="Fields"/>
  64. <publicstaticattributes title=""/>
  65. <protectedtypes title=""/>
  66. <protectedslots title=""/>
  67. <protectedmethods title=""/>
  68. <protectedstaticmethods title=""/>
  69. <protectedattributes title=""/>
  70. <protectedstaticattributes title=""/>
  71. <packagetypes title=""/>
  72. <packagemethods title=""/>
  73. <packagestaticmethods title=""/>
  74. <packageattributes title=""/>
  75. <packagestaticattributes title=""/>
  76. <properties title=""/>
  77. <events title=""/>
  78. <privatetypes title=""/>
  79. <privateslots title=""/>
  80. <privatemethods title=""/>
  81. <privatestaticmethods title=""/>
  82. <privateattributes title=""/>
  83. <privatestaticattributes title=""/>
  84. <friends title=""/>
  85. <related title="" subtitle=""/>
  86. <membergroups visible="yes"/>
  87. </memberdecl>
  88. <detaileddescription title=""/>
  89. <memberdef>
  90. <inlineclasses title=""/>
  91. <typedefs title=""/>
  92. <enums title=""/>
  93. <constructors title=""/>
  94. <!-- T2D: rename "Public Method Functions" to be just "Methods" for TorqueScript -->
  95. <functions title="Methods"/>
  96. <related title=""/>
  97. <variables title=""/>
  98. <properties title=""/>
  99. <events title=""/>
  100. </memberdef>
  101. <allmemberslink visible="yes"/>
  102. <usedfiles visible="$SHOW_USED_FILES"/>
  103. <authorsection visible="yes"/>
  104. </class>
  105. <!-- Layout definition for a namespace page -->
  106. <!-- T2D: we will make namespaces look like "function categories" which
  107. hold sets of global TorqueScript functions. This is simply a hack.
  108. -->
  109. <namespace>
  110. <briefdescription visible="yes"/>
  111. <memberdecl>
  112. <nestednamespaces visible="yes" title="Function Categories"/>
  113. <classes visible="yes" title=""/>
  114. <typedefs title=""/>
  115. <enums title=""/>
  116. <functions title=""/>
  117. <variables title=""/>
  118. <membergroups visible="yes"/>
  119. </memberdecl>
  120. <detaileddescription title=""/>
  121. <memberdef>
  122. <inlineclasses title=""/>
  123. <typedefs title=""/>
  124. <enums title=""/>
  125. <functions title=""/>
  126. <variables title=""/>
  127. </memberdef>
  128. <authorsection visible="yes"/>
  129. </namespace>
  130. <!-- Layout definition for a file page -->
  131. <file>
  132. <briefdescription visible="yes"/>
  133. <includes visible="$SHOW_INCLUDE_FILES"/>
  134. <includegraph visible="$INCLUDE_GRAPH"/>
  135. <includedbygraph visible="$INCLUDED_BY_GRAPH"/>
  136. <sourcelink visible="yes"/>
  137. <memberdecl>
  138. <classes visible="yes" title=""/>
  139. <namespaces visible="yes" title=""/>
  140. <defines title=""/>
  141. <typedefs title=""/>
  142. <enums title=""/>
  143. <functions title=""/>
  144. <variables title=""/>
  145. <membergroups visible="yes"/>
  146. </memberdecl>
  147. <detaileddescription title=""/>
  148. <memberdef>
  149. <inlineclasses title=""/>
  150. <defines title=""/>
  151. <typedefs title=""/>
  152. <enums title=""/>
  153. <functions title=""/>
  154. <variables title=""/>
  155. </memberdef>
  156. <authorsection/>
  157. </file>
  158. <!-- Layout definition for a group page -->
  159. <group>
  160. <briefdescription visible="yes"/>
  161. <groupgraph visible="$GROUP_GRAPHS"/>
  162. <memberdecl>
  163. <nestedgroups visible="yes" title=""/>
  164. <dirs visible="yes" title=""/>
  165. <files visible="yes" title=""/>
  166. <namespaces visible="yes" title=""/>
  167. <classes visible="yes" title=""/>
  168. <defines title=""/>
  169. <typedefs title=""/>
  170. <enums title=""/>
  171. <enumvalues title=""/>
  172. <functions title=""/>
  173. <variables title=""/>
  174. <signals title=""/>
  175. <publicslots title=""/>
  176. <protectedslots title=""/>
  177. <privateslots title=""/>
  178. <events title=""/>
  179. <properties title=""/>
  180. <friends title=""/>
  181. <membergroups visible="yes"/>
  182. </memberdecl>
  183. <detaileddescription title=""/>
  184. <memberdef>
  185. <pagedocs/>
  186. <inlineclasses title=""/>
  187. <defines title=""/>
  188. <typedefs title=""/>
  189. <enums title=""/>
  190. <enumvalues title=""/>
  191. <functions title=""/>
  192. <variables title=""/>
  193. <signals title=""/>
  194. <publicslots title=""/>
  195. <protectedslots title=""/>
  196. <privateslots title=""/>
  197. <events title=""/>
  198. <properties title=""/>
  199. <friends title=""/>
  200. </memberdef>
  201. <authorsection visible="yes"/>
  202. </group>
  203. <!-- Layout definition for a directory page -->
  204. <directory>
  205. <briefdescription visible="yes"/>
  206. <directorygraph visible="yes"/>
  207. <memberdecl>
  208. <dirs visible="yes"/>
  209. <files visible="yes"/>
  210. </memberdecl>
  211. <detaileddescription title=""/>
  212. </directory>
  213. </doxygenlayout>