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