doc/Layout.xml

   1 <doxygenlayout version="1.0">
   2   <!-- Navigation index tabs for HTML output -->
   3   <navindex>
   4     <!--<tab type="usergroup" visible="yes" title="Getting started" intro="Getting started" url="@ref getting_started">
   5       <tab type="user" visible="yes" url="@ref getting_started" title="What to read" />
   6       <tab type="user" visible="yes" url="@ref install" title="Installing SimGrid" />
   7       <tab type="user" visible="yes" url="@ref help" title="Getting help" />
   8     </tab>-->
   9
  10     <tab type="mainpage" visible="yes" title="SimGrid User Documentation" />
  11
  12     <tab type="usergroup" visible="yes" title="Reference documentation" intro="Reference documentation">
  13       <tab type="namespaces" visible="no" title="">
  14       <tab type="namespaces" visible="yes" title="" intro=""/>
  15       <tab type="namespacemembers" visible="yes" title="" intro=""/>
  16     </tab>
  17       <tab type="classes" visible="no" title="">
  18         <tab type="classes" visible="yes" title="" intro=""/>
  19         <tab type="classindex" visible="$ALPHABETICAL_INDEX" title=""/>
  20         <tab type="hierarchy" visible="yes" title="" intro=""/>
  21         <tab type="classmembers" visible="yes" title="" intro=""/>
  22       </tab>
  23       <tab type="files" visible="no" title="">
  24         <tab type="files" visible="yes" title="" intro=""/>
  25         <tab type="globals" visible="yes" title="" intro=""/>
  26       </tab>
  27       <tab type="modules" visible="no" title="" intro="">
  28         <tab type="modules" visible="yes" title="APIs Reference"
  29              intro="Here is the hierarchical view of all SimGrid modules. You can reduce the amount of detail with the 'detail level' setting, on the right."/>
  30       </tab>
  31     </tab>
  32   </navindex>
  33
  34   <!-- Layout definition for a class page -->
  35   <class>
  36     <briefdescription visible="yes"/>
  37     <includes visible="$SHOW_INCLUDE_FILES"/>
  38     <inheritancegraph visible="$CLASS_GRAPH"/>
  39     <collaborationgraph visible="$COLLABORATION_GRAPH"/>
  40     <allmemberslink visible="yes"/>
  41     <memberdecl>
  42       <nestedclasses visible="yes" title=""/>
  43       <publictypes title=""/>
  44       <publicslots title=""/>
  45       <signals title=""/>
  46       <publicmethods title=""/>
  47       <publicstaticmethods title=""/>
  48       <publicattributes title=""/>
  49       <publicstaticattributes title=""/>
  50       <protectedtypes title=""/>
  51       <protectedslots title=""/>
  52       <protectedmethods title=""/>
  53       <protectedstaticmethods title=""/>
  54       <protectedattributes title=""/>
  55       <protectedstaticattributes title=""/>
  56       <packagetypes title=""/>
  57       <packagemethods title=""/>
  58       <packagestaticmethods title=""/>
  59       <packageattributes title=""/>
  60       <packagestaticattributes title=""/>
  61       <properties title=""/>
  62       <events title=""/>
  63       <privatetypes title=""/>
  64       <privateslots title=""/>
  65       <privatemethods title=""/>
  66       <privatestaticmethods title=""/>
  67       <privateattributes title=""/>
  68       <privatestaticattributes title=""/>
  69       <friends title=""/>
  70       <related title="" subtitle=""/>
  71       <membergroups visible="yes"/>
  72     </memberdecl>
  73     <detaileddescription title=""/>
  74     <memberdef>
  75       <typedefs title=""/>
  76       <enums title=""/>
  77       <constructors title=""/>
  78       <functions title=""/>
  79       <related title=""/>
  80       <variables title=""/>
  81       <properties title=""/>
  82       <events title=""/>
  83     </memberdef>
  84     <usedfiles visible="$SHOW_USED_FILES"/>
  85     <authorsection visible="yes"/>
  86   </class>
  87
  88   <!-- Layout definition for a namespace page -->
  89   <namespace>
  90     <briefdescription visible="yes"/>
  91     <memberdecl>
  92       <nestednamespaces visible="yes" title=""/>
  93       <classes visible="yes" title=""/>
  94       <typedefs title=""/>
  95       <enums title=""/>
  96       <functions title=""/>
  97       <variables title=""/>
  98       <membergroups visible="yes"/>
  99     </memberdecl>
 100     <detaileddescription title=""/>
 101     <memberdef>
 102       <typedefs title=""/>
 103       <enums title=""/>
 104       <functions title=""/>
 105       <variables title=""/>
 106     </memberdef>
 107     <authorsection visible="yes"/>
 108   </namespace>
 109
 110   <!-- Layout definition for a file page -->
 111   <file>
 112     <briefdescription visible="yes"/>
 113     <includes visible="$SHOW_INCLUDE_FILES"/>
 114     <includegraph visible="$INCLUDE_GRAPH"/>
 115     <includedbygraph visible="$INCLUDED_BY_GRAPH"/>
 116     <sourcelink visible="yes"/>
 117     <memberdecl>
 118       <classes visible="yes" title=""/>
 119       <namespaces visible="yes" title=""/>
 120       <defines title=""/>
 121       <typedefs title=""/>
 122       <enums title=""/>
 123       <functions title=""/>
 124       <variables title=""/>
 125       <membergroups visible="yes"/>
 126     </memberdecl>
 127     <detaileddescription title=""/>
 128     <memberdef>
 129       <defines title=""/>
 130       <typedefs title=""/>
 131       <enums title=""/>
 132       <functions title=""/>
 133       <variables title=""/>
 134     </memberdef>
 135     <authorsection/>
 136   </file>
 137
 138   <!-- Layout definition for a group page -->
 139   <group>
 140     <briefdescription visible="yes"/>
 141     <groupgraph visible="$GROUP_GRAPHS"/>
 142     <memberdecl>
 143       <classes visible="yes" title=""/>
 144       <namespaces visible="yes" title=""/>
 145       <dirs visible="yes" title=""/>
 146       <nestedgroups visible="yes" title=""/>
 147       <files visible="yes" title=""/>
 148       <defines title=""/>
 149       <typedefs title=""/>
 150       <enums title=""/>
 151       <enumvalues title=""/>
 152       <functions title=""/>
 153       <variables title=""/>
 154       <signals title=""/>
 155       <publicslots title=""/>
 156       <protectedslots title=""/>
 157       <privateslots title=""/>
 158       <events title=""/>
 159       <properties title=""/>
 160       <friends title=""/>
 161       <membergroups visible="yes"/>
 162     </memberdecl>
 163     <detaileddescription title=""/>
 164     <memberdef>
 165       <pagedocs/>
 166       <inlineclasses title=""/>
 167       <defines title=""/>
 168       <typedefs title=""/>
 169       <enums title=""/>
 170       <enumvalues title=""/>
 171       <functions title=""/>
 172       <variables title=""/>
 173       <signals title=""/>
 174       <publicslots title=""/>
 175       <protectedslots title=""/>
 176       <privateslots title=""/>
 177       <events title=""/>
 178       <properties title=""/>
 179       <friends title=""/>
 180     </memberdef>
 181     <authorsection visible="yes"/>
 182   </group>
 183
 184   <!-- Layout definition for a directory page -->
 185   <directory>
 186     <briefdescription visible="yes"/>
 187     <directorygraph visible="yes"/>
 188     <memberdecl>
 189       <dirs visible="yes"/>
 190       <files visible="yes"/>
 191     </memberdecl>
 192     <detaileddescription title=""/>
 193   </directory>
 194 </doxygenlayout>