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