Merge pull request #254 from mpotse/develop

Make the API documentation easier to find

README.md

@@ -190,7 +190,7 @@ Man pages are available inside the **doc/man** directory:
 Run the `make doc` command to build the Doxygen documentation, after running `cmake`
   with the option `-DBUILD_DOC=yes` if you did not already do so.
   You may wish to adapt `build/Doxyfile` to your liking.
-  * To see the **mmg** documentation, open the file **<build>/doc/index.html**.
+  * To see the **mmg** documentation, open the file `<build>/doc/index.html`.
 
 ## Platforms
 The **mmg** applications are tested on OS X and on most of the Linux platforms.

doc/doxygen/Doxyfile.in

@@ -645,7 +645,7 @@ FILE_VERSION_FILTER    =
 # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
 # tag is left empty.
 
-LAYOUT_FILE            =
+LAYOUT_FILE            = @CMAKE_CURRENT_SOURCE_DIR@/doc/doxygen/DoxygenLayout.xml
 
 # The CITE_BIB_FILES tag can be used to specify one or more bib files containing
 # the reference definitions. This must be a list of .bib files. The .bib

doc/doxygen/DoxygenLayout.xml

@@ -0,0 +1,229 @@
+<doxygenlayout version="1.0">
+  <!-- original version Generated by doxygen 1.8.17 -->
+  <!-- In Mmg this is used to create a tab in the navindex that points to the API group -->
+  <!-- For this file to work the LAYOUT_FILE in Doxyfile must point to it -->
+  <!-- Navigation index tabs for HTML output -->
+  <navindex>
+    <tab type="mainpage" visible="yes" title=""/>
+    <tab type="pages" visible="yes" title="" intro=""/>
+    <tab type="modules" visible="no" title="" intro=""/>
+    <tab type="user" visible="yes" title="API" url="@ref API" intro=""/>
+    <tab type="namespaces" visible="yes" title="">
+      <tab type="namespacelist" visible="yes" title="" intro=""/>
+      <tab type="namespacemembers" visible="yes" title="" intro=""/>
+    </tab>
+    <tab type="interfaces" visible="yes" title="">
+      <tab type="interfacelist" visible="yes" title="" intro=""/>
+      <tab type="interfaceindex" visible="$ALPHABETICAL_INDEX" title=""/>
+      <tab type="interfacehierarchy" visible="yes" title="" intro=""/>
+    </tab>
+    <tab type="classes" visible="yes" title="">
+      <tab type="classlist" visible="yes" title="" intro=""/>
+      <tab type="classindex" visible="$ALPHABETICAL_INDEX" title=""/>
+      <tab type="hierarchy" visible="yes" title="" intro=""/>
+      <tab type="classmembers" visible="yes" title="" intro=""/>
+    </tab>
+    <tab type="structs" visible="yes" title="">
+      <tab type="structlist" visible="yes" title="" intro=""/>
+      <tab type="structindex" visible="$ALPHABETICAL_INDEX" title=""/>
+    </tab>
+    <tab type="exceptions" visible="yes" title="">
+      <tab type="exceptionlist" visible="yes" title="" intro=""/>
+      <tab type="exceptionindex" visible="$ALPHABETICAL_INDEX" title=""/>
+      <tab type="exceptionhierarchy" visible="yes" title="" intro=""/>
+    </tab>
+    <tab type="files" visible="yes" title="">
+      <tab type="filelist" visible="yes" title="" intro=""/>
+      <tab type="globals" visible="yes" title="" intro=""/>
+    </tab>
+    <tab type="examples" visible="yes" title="" intro=""/>
+  </navindex>
+
+  <!-- Layout definition for a class page -->
+  <class>
+    <briefdescription visible="yes"/>
+    <includes visible="$SHOW_INCLUDE_FILES"/>
+    <inheritancegraph visible="$CLASS_GRAPH"/>
+    <collaborationgraph visible="$COLLABORATION_GRAPH"/>
+    <memberdecl>
+      <nestedclasses visible="yes" title=""/>
+      <publictypes title=""/>
+      <services title=""/>
+      <interfaces title=""/>
+      <publicslots title=""/>
+      <signals title=""/>
+      <publicmethods title=""/>
+      <publicstaticmethods title=""/>
+      <publicattributes title=""/>
+      <publicstaticattributes title=""/>
+      <protectedtypes title=""/>
+      <protectedslots title=""/>
+      <protectedmethods title=""/>
+      <protectedstaticmethods title=""/>
+      <protectedattributes title=""/>
+      <protectedstaticattributes title=""/>
+      <packagetypes title=""/>
+      <packagemethods title=""/>
+      <packagestaticmethods title=""/>
+      <packageattributes title=""/>
+      <packagestaticattributes title=""/>
+      <properties title=""/>
+      <events title=""/>
+      <privatetypes title=""/>
+      <privateslots title=""/>
+      <privatemethods title=""/>
+      <privatestaticmethods title=""/>
+      <privateattributes title=""/>
+      <privatestaticattributes title=""/>
+      <friends title=""/>
+      <related title="" subtitle=""/>
+      <membergroups visible="yes"/>
+    </memberdecl>
+    <detaileddescription title=""/>
+    <memberdef>
+      <inlineclasses title=""/>
+      <typedefs title=""/>
+      <enums title=""/>
+      <services title=""/>
+      <interfaces title=""/>
+      <constructors title=""/>
+      <functions title=""/>
+      <related title=""/>
+      <variables title=""/>
+      <properties title=""/>
+      <events title=""/>
+    </memberdef>
+    <allmemberslink visible="yes"/>
+    <usedfiles visible="$SHOW_USED_FILES"/>
+    <authorsection visible="yes"/>
+  </class>
+
+  <!-- Layout definition for a namespace page -->
+  <namespace>
+    <briefdescription visible="yes"/>
+    <memberdecl>
+      <nestednamespaces visible="yes" title=""/>
+      <constantgroups visible="yes" title=""/>
+      <interfaces visible="yes" title=""/>
+      <classes visible="yes" title=""/>
+      <structs visible="yes" title=""/>
+      <exceptions visible="yes" title=""/>
+      <typedefs title=""/>
+      <sequences title=""/>
+      <dictionaries title=""/>
+      <enums title=""/>
+      <functions title=""/>
+      <variables title=""/>
+      <membergroups visible="yes"/>
+    </memberdecl>
+    <detaileddescription title=""/>
+    <memberdef>
+      <inlineclasses title=""/>
+      <typedefs title=""/>
+      <sequences title=""/>
+      <dictionaries title=""/>
+      <enums title=""/>
+      <functions title=""/>
+      <variables title=""/>
+    </memberdef>
+    <authorsection visible="yes"/>
+  </namespace>
+
+  <!-- Layout definition for a file page -->
+  <file>
+    <briefdescription visible="yes"/>
+    <includes visible="$SHOW_INCLUDE_FILES"/>
+    <includegraph visible="$INCLUDE_GRAPH"/>
+    <includedbygraph visible="$INCLUDED_BY_GRAPH"/>
+    <sourcelink visible="yes"/>
+    <memberdecl>
+      <interfaces visible="yes" title=""/>
+      <classes visible="yes" title=""/>
+      <structs visible="yes" title=""/>
+      <exceptions visible="yes" title=""/>
+      <namespaces visible="yes" title=""/>
+      <constantgroups visible="yes" title=""/>
+      <defines title=""/>
+      <typedefs title=""/>
+      <sequences title=""/>
+      <dictionaries title=""/>
+      <enums title=""/>
+      <functions title=""/>
+      <variables title=""/>
+      <membergroups visible="yes"/>
+    </memberdecl>
+    <detaileddescription title=""/>
+    <memberdef>
+      <inlineclasses title=""/>
+      <defines title=""/>
+      <typedefs title=""/>
+      <sequences title=""/>
+      <dictionaries title=""/>
+      <enums title=""/>
+      <functions title=""/>
+      <variables title=""/>
+    </memberdef>
+    <authorsection/>
+  </file>
+
+  <!-- Layout definition for a group page -->
+  <group>
+    <briefdescription visible="no"/>
+    <groupgraph visible="$GROUP_GRAPHS"/>
+    <memberdecl>
+      <nestedgroups visible="yes" title=""/>
+      <dirs visible="yes" title=""/>
+      <files visible="yes" title=""/>
+      <namespaces visible="yes" title=""/>
+      <classes visible="yes" title=""/>
+      <defines title=""/>
+      <typedefs title=""/>
+      <sequences title=""/>
+      <dictionaries title=""/>
+      <enums title=""/>
+      <enumvalues title=""/>
+      <functions title=""/>
+      <variables title=""/>
+      <signals title=""/>
+      <publicslots title=""/>
+      <protectedslots title=""/>
+      <privateslots title=""/>
+      <events title=""/>
+      <properties title=""/>
+      <friends title=""/>
+      <membergroups visible="yes"/>
+    </memberdecl>
+    <detaileddescription title="Introduction"/>
+    <memberdef>
+      <pagedocs/>
+      <inlineclasses title=""/>
+      <defines title=""/>
+      <typedefs title=""/>
+      <sequences title=""/>
+      <dictionaries title=""/>
+      <enums title=""/>
+      <enumvalues title=""/>
+      <functions title=""/>
+      <variables title=""/>
+      <signals title=""/>
+      <publicslots title=""/>
+      <protectedslots title=""/>
+      <privateslots title=""/>
+      <events title=""/>
+      <properties title=""/>
+      <friends title=""/>
+    </memberdef>
+    <authorsection visible="yes"/>
+  </group>
+
+  <!-- Layout definition for a directory page -->
+  <directory>
+    <briefdescription visible="yes"/>
+    <directorygraph visible="yes"/>
+    <memberdecl>
+      <dirs visible="yes"/>
+      <files visible="yes"/>
+    </memberdecl>
+    <detaileddescription title=""/>
+  </directory>
+</doxygenlayout>

libexamples/mmg/adaptation_example0/README.md

@@ -1,4 +1,4 @@
-# Basic use of the **mmg** library for an adaptation testcase
+# Basic use of the mmg library for an adaptation testcase
 
 ## I/ Implementation
 To call the **mmg** library, you must:  

libexamples/mmg/adaptation_example0_cpp/README.md

@@ -1,4 +1,4 @@
-# Basic use of the **mmg** library for an adaptation testcase in C++
+# Basic use of the mmg library for an adaptation testcase in C++
 
 ## I/ Implementation
 To call the **mmg** library, you must:  

libexamples/mmg/adaptation_example0_fortran/README.md

@@ -1,4 +1,4 @@
-# Basic use of the **mmg** library for an adaptation testcase for Fortran users
+# Basic use of the mmg library for an adaptation testcase for Fortran users
 
 ## I/ Implementation
 To call the **mmg** library, you must:  

libexamples/mmg2d/adaptation_example0/README.md

@@ -1,4 +1,4 @@
-# Basic use of the **mmg2d** library
+# Basic use of the mmg2d library
 
 ## I/ Implementation
 To call the **mmg2d** library, you must:  

libexamples/mmg2d/adaptation_example0_fortran/README.md

@@ -1,4 +1,4 @@
-# Basic use of the **mmg2d** library for a **Fortran** call
+# Basic use of the mmg2d library for a Fortran call
 
 ## I/ Implementation
 To call the **mmg3d** library, you must:  

libexamples/mmg2d/adaptation_example1/README.md

@@ -1,4 +1,4 @@
-# Basic use of the **mmg2d** library to perform mesh adaptation
+# Basic use of the mmg2d library to perform mesh adaptation
 
 ## I/ Implementation
 To call the **mmg2d** library, you must:  

libexamples/mmg2d/adaptation_example2/README.md

@@ -1,4 +1,4 @@
-# Basic use of the **mmg2d** library to perform mesh adaptation with 2 calls of the library and deletion of the metric between the call.
+# Basic use of the mmg2d library to perform mesh adaptation with 2 calls of the library and deletion of the metric between the call.
 
 ## I/ Implementation
 This example:  

libexamples/mmg2d/adaptation_example3/README.md

@@ -1,4 +1,4 @@
-# Basic use of the **mmg2d** library
+# Basic use of the mmg2d library
 
 ## Adaptation example 3
 No mesh or sol file necessary, only compilation of main.c.

libexamples/mmg2d/squareGeneration_example0/README.md

@@ -1,4 +1,4 @@
-# Basic use of the **mmg2d** library to perform mesh generation
+# Basic use of the mmg2d library to perform mesh generation
 
 ## I/ Implementation
 To call the **mmg2d** library, you must:  

libexamples/mmg3d/adaptation_example0/README.md

@@ -1,4 +1,4 @@
-# Basic use of the **mmg3d** library
+# Basic use of the mmg3d library
 
 ## I/ Implementation
 To call the **mmg3d** library, you must:  

libexamples/mmg3d/adaptation_example0_fortran/README.md

@@ -1,4 +1,4 @@
-# Basic use of the **mmg3d** library for a **Fortran** call
+# Basic use of the mmg3d library for a Fortran call
 
 ## I/ Implementation
 To call the **mmg3d** library, you must:  

libexamples/mmgs/IsosurfDiscretization_example0/README.md

@@ -1,4 +1,4 @@
-# Example of basic use of library **libmmgs** for a level-set discretization test case
+# Example of basic use of library libmmgs for a level-set discretization test case
 
 ## I/ Implementation
   We read the mesh and level-set values at the mesh nodes and then, we discretize the implicit function and optimize the mesh.

libexamples/mmgs/adaptation_example0/README.md

@@ -1,4 +1,4 @@
-# Basic use of the **mmgs** library for an adaptation testcase
+# Basic use of the mmgs library for an adaptation testcase
 
 ## I/ Implementation
 To call the **mmgs** library, you must:  

libexamples/mmgs/adaptation_example0_fortran/README.md

@@ -1,4 +1,4 @@
-# Basic use of the **mmgs** library for a **Fortran** call
+# Basic use of the mmgs library for a Fortran call
 
 ## I/ Implementation
 To call the **mmgs** library, you must:  

libexamples/mmgs/adaptation_example0_fortran/example0_a/README.md

@@ -1,4 +1,4 @@
-# Basic use of the **mmgs** library for a **Fortran** call (adaptation test case)
+# Basic use of the mmgs library for a Fortran call (adaptation test case)
 
 ## I/ Implementation
 To call the **mmgs** library, you must:  

libexamples/mmgs/adaptation_example1/README.md

@@ -1,4 +1,4 @@
-# Advanced use of the **mmgs** library for an adaptation test case
+# Advanced use of the mmgs library for an adaptation test case
 
 ## I/ Implementation
 To call the **mmgs** library, you must: