doc/Layout.xml

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