Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Connect log category xbt_heap.
[simgrid.git] / tools / doxygen / index_create.pl
index 857fa1b..e7522cc 100755 (executable)
@@ -37,15 +37,21 @@ close FILE;
 
 open OUTPUT,"> $output";
 print OUTPUT <<EOF;
-/** \\defgroup API_index Index of the API
-  * \\ingroup SimGrid_API
+This file was generated by tools/doxygen/index_create.pl. DO NOT EDIT.
+
+/** \\defgroup API_index Full Index
+  * \\brief The alphabetical list of all functions, macros and types 
+  *  defined by SimGrid
   *
   * List of all functions, variables, defines, enums, and typedefs with
-  * links to their documentation.
+  * links to the files they belong to. 
+  *
+  * \\htmlonly Altough completely useless, the complete list of structures defined can be found <a href="annotated.html">here</a> \\endhtmlonly
+
 
 EOF
 
-foreach $type qw(define enumeration enumvalue function typedef) {
+foreach $type (qw(define enumeration enumvalue function typedef)) {
     if(defined $database{$type}) {
        print OUTPUT "<h2>$type</h2> \n  <ul>\n";
        foreach $name (sort keys %{$database{$type}}) {