tweak the documentation rendering

diff --git a/doc/Doxyfile.in b/doc/Doxyfile.in
index 832f055..75a24f4 100644 (file)
--- a/doc/Doxyfile.in
+++ b/doc/Doxyfile.in
@@ -1466,14 +1466,13 @@ INCLUDE_FILE_PATTERNS  =
 # undefined via #undef or recursively expanded use the := operator
 # instead of the = operator.
 
 # undefined via #undef or recursively expanded use the := operator
 # instead of the = operator.
 

-PREDEFINED             = DOXYGEN \
-                         DOXYGEN_SKIP_IT \
-                         XBT_PUBLIC(type)="extern type" \
+PREDEFINED             = XBT_PUBLIC(type)="extern type" \

                          XBT_EXPORT_NO_IMPORT(type)=type \
                          XBT_IMPORT_NO_EXPORT(type)=type \
                          XBT_PUBLIC_DATA(type)="extern type" \
                          XBT_PUBLIC_CLASS=class \
                          XBT_EXPORT_NO_IMPORT(type)=type \
                          XBT_IMPORT_NO_EXPORT(type)=type \
                          XBT_PUBLIC_DATA(type)="extern type" \
                          XBT_PUBLIC_CLASS=class \

-                         XBT_INLINE= 
+                         XBT_INLINE= \
+                        XBT_PRIVATE=/** @private /

 
 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
 # this tag can be used to specify a list of macro names that should be expanded.
 
 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
 # this tag can be used to specify a list of macro names that should be expanded.

diff --git a/doc/Layout.xml b/doc/Layout.xml
index 585a480..eb71a76 100644 (file)
--- a/doc/Layout.xml
+++ b/doc/Layout.xml
@@ -1,28 +1,18 @@
 <doxygenlayout version="1.0">
   <!-- Navigation index tabs for HTML output -->
   <navindex>
 <doxygenlayout version="1.0">
   <!-- Navigation index tabs for HTML output -->
   <navindex>

-    <!--<tab type="usergroup" visible="yes" title="Getting started" intro="Getting started" url="@ref getting_started">
-      <tab type="user" visible="yes" url="@ref getting_started" title="What to read" />
-      <tab type="user" visible="yes" url="@ref install" title="Installing SimGrid" />
-      <tab type="user" visible="yes" url="@ref help" title="Getting help" />
-    </tab>-->

     
     <tab type="mainpage" visible="yes" title="SimGrid User Documentation" />
 
     <tab type="usergroup" visible="yes" title="Reference documentation" intro="Reference documentation">
       <tab type="namespaces" visible="no" title="">
     
     <tab type="mainpage" visible="yes" title="SimGrid User Documentation" />
 
     <tab type="usergroup" visible="yes" title="Reference documentation" intro="Reference documentation">
       <tab type="namespaces" visible="no" title="">

-      <tab type="namespaces" visible="yes" title="" intro=""/>
-      <tab type="namespacemembers" visible="yes" title="" intro=""/>
-    </tab>
+        <tab type="namespaces" visible="yes" title="" intro=""/>
+      </tab>

       <tab type="classes" visible="no" title="">
         <tab type="classes" visible="yes" title="" intro=""/>
         <tab type="classindex" visible="$ALPHABETICAL_INDEX" title=""/> 
         <tab type="hierarchy" visible="yes" title="" intro=""/>
       <tab type="classes" visible="no" title="">
         <tab type="classes" 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="files" visible="no" title="">
-        <tab type="files" visible="yes" title="" intro=""/>
-        <tab type="globals" visible="yes" title="" intro=""/>
+        <tab type="classmembers" visible="no" title="" intro=""/>

       </tab>
       <tab type="modules" visible="no" title="" intro="">
         <tab type="modules" visible="yes" title="APIs Reference"
       </tab>
       <tab type="modules" visible="no" title="" intro="">
         <tab type="modules" visible="yes" title="APIs Reference"


@@ -137,6 +127,7 @@
 
   <!-- Layout definition for a group page -->
   <group>
 
   <!-- Layout definition for a group page -->
   <group>

+    <detaileddescription title=""/>

     <briefdescription visible="yes"/>
     <groupgraph visible="$GROUP_GRAPHS"/>
     <memberdecl>
     <briefdescription visible="yes"/>
     <groupgraph visible="$GROUP_GRAPHS"/>
     <memberdecl>


@@ -160,7 +151,6 @@
       <friends title=""/>
       <membergroups visible="yes"/>
     </memberdecl>
       <friends title=""/>
       <membergroups visible="yes"/>
     </memberdecl>

-    <detaileddescription title=""/>

     <memberdef>
       <pagedocs/>
       <inlineclasses title=""/>
     <memberdef>
       <pagedocs/>
       <inlineclasses title=""/>

diff --git a/doc/doxygen/platform.doc b/doc/doxygen/platform.doc
index e276c98..d8233b5 100644 (file)
--- a/doc/doxygen/platform.doc
+++ b/doc/doxygen/platform.doc
@@ -1,4 +1,4 @@
-/*! \page platform Describe the underlying platform
+/*! \page platform Describing the virtual platform

 
 @tableofcontents
 
 
 @tableofcontents
 

diff --git a/include/xbt/base.h b/include/xbt/base.h
index 38f9308..285c3f6 100644 (file)
--- a/include/xbt/base.h
+++ b/include/xbt/base.h
@@ -168,7 +168,7 @@
 #  define XBT_IMPORT_NO_EXPORT(type)  type
 #  define XBT_PUBLIC_DATA(type)       extern type
 #  define XBT_PUBLIC_CLASS            class
 #  define XBT_IMPORT_NO_EXPORT(type)  type
 #  define XBT_PUBLIC_DATA(type)       extern type
 #  define XBT_PUBLIC_CLASS            class

-#  define XBT_PRIVATE
+#  define XBT_PRIVATE                 /** @private */

 
 #endif
 
 
 #endif
 

diff --git a/src/simix/popping_bodies.cpp b/src/simix/popping_bodies.cpp
index b872bbb..57e3e9a 100644 (file)
--- a/src/simix/popping_bodies.cpp
+++ b/src/simix/popping_bodies.cpp
@@ -17,6 +17,7 @@
 #include "src/mc/mc_forward.hpp"
 #include "xbt/ex.h"
 #include <simgrid/simix.hpp>
 #include "src/mc/mc_forward.hpp"
 #include "xbt/ex.h"
 #include <simgrid/simix.hpp>

+/** @cond */ // Please Doxygen, don't look at this

   
 inline static void simcall_BODY_vm_suspend(sg_host_t ind_vm) {
     smx_process_t self = SIMIX_process_self();
   
 inline static void simcall_BODY_vm_suspend(sg_host_t ind_vm) {
     smx_process_t self = SIMIX_process_self();


@@ -1549,4 +1550,4 @@ inline static void simcall_BODY_run_kernel(void* code) {
       SIMIX_simcall_handle(&self->simcall, 0);
     }    
     
       SIMIX_simcall_handle(&self->simcall, 0);
     }    
     

-  }
\ No newline at end of file
+  }/** @endcond */

diff --git a/src/simix/popping_generated.cpp b/src/simix/popping_generated.cpp
index c572811..806eb32 100644 (file)
--- a/src/simix/popping_generated.cpp
+++ b/src/simix/popping_generated.cpp
@@ -93,7 +93,7 @@ const char* simcall_names[] = {
   "SIMCALL_SET_CATEGORY",
   "SIMCALL_RUN_KERNEL",};
 
   "SIMCALL_SET_CATEGORY",
   "SIMCALL_RUN_KERNEL",};
 

-/**
+/** @private

  * @brief (in kernel mode) unpack the simcall and activate the handler
  * 
  * This function is generated from src/simix/simcalls.in
  * @brief (in kernel mode) unpack the simcall and activate the handler
  * 
  * This function is generated from src/simix/simcalls.in

diff --git a/src/simix/simcalls.py b/src/simix/simcalls.py
index 3bf49a5..46c7101 100755 (executable)
--- a/src/simix/simcalls.py
+++ b/src/simix/simcalls.py
@@ -323,7 +323,7 @@ if __name__ == '__main__':
 
     fd.write('};\n\n')
 
 
     fd.write('};\n\n')
 

-    fd.write('/**\n')
+    fd.write('/** @private\n')

     fd.write(
         ' * @brief (in kernel mode) unpack the simcall and activate the handler\n')
     fd.write(' * \n')
     fd.write(
         ' * @brief (in kernel mode) unpack the simcall and activate the handler\n')
     fd.write(' * \n')


@@ -365,5 +365,7 @@ if __name__ == '__main__':
     fd.write('#include "src/mc/mc_forward.hpp"\n')
     fd.write('#include "xbt/ex.h"\n')
     fd.write('#include <simgrid/simix.hpp>\n')
     fd.write('#include "src/mc/mc_forward.hpp"\n')
     fd.write('#include "xbt/ex.h"\n')
     fd.write('#include <simgrid/simix.hpp>\n')

+    fd.write("/** @cond */ // Please Doxygen, don't look at this\n")

     handle(fd, Simcall.body, simcalls, simcalls_dict)
     handle(fd, Simcall.body, simcalls, simcalls_dict)

+    fd.write("/** @endcond */\n");

     fd.close()
     fd.close()

diff --git a/src/simix/smx_network.cpp b/src/simix/smx_network.cpp
index 3db60d6..c4e1464 100644 (file)
--- a/src/simix/smx_network.cpp
+++ b/src/simix/smx_network.cpp
@@ -155,7 +155,7 @@ static smx_synchro_t _find_matching_comm(std::deque<smx_synchro_t> *deque, e_smx
 /******************************************************************************/
 /*                          Communication synchros                            */
 /******************************************************************************/
 /******************************************************************************/
 /*                          Communication synchros                            */
 /******************************************************************************/

-void simcall_HANDLER_comm_send(smx_simcall_t simcall, smx_process_t src, smx_mailbox_t mbox,
+XBT_PRIVATE void simcall_HANDLER_comm_send(smx_simcall_t simcall, smx_process_t src, smx_mailbox_t mbox,

                                   double task_size, double rate,
                                   void *src_buff, size_t src_buff_size,
                                   int (*match_fun)(void *, void *,smx_synchro_t),
                                   double task_size, double rate,
                                   void *src_buff, size_t src_buff_size,
                                   int (*match_fun)(void *, void *,smx_synchro_t),


@@ -167,7 +167,7 @@ void simcall_HANDLER_comm_send(smx_simcall_t simcall, smx_process_t src, smx_mai
   SIMCALL_SET_MC_VALUE(simcall, 0);
   simcall_HANDLER_comm_wait(simcall, comm, timeout);
 }
   SIMCALL_SET_MC_VALUE(simcall, 0);
   simcall_HANDLER_comm_wait(simcall, comm, timeout);
 }

-smx_synchro_t simcall_HANDLER_comm_isend(smx_simcall_t simcall, smx_process_t src_proc, smx_mailbox_t mbox,
+XBT_PRIVATE smx_synchro_t simcall_HANDLER_comm_isend(smx_simcall_t simcall, smx_process_t src_proc, smx_mailbox_t mbox,

                                   double task_size, double rate,
                                   void *src_buff, size_t src_buff_size,
                                   int (*match_fun)(void *, void *,smx_synchro_t),
                                   double task_size, double rate,
                                   void *src_buff, size_t src_buff_size,
                                   int (*match_fun)(void *, void *,smx_synchro_t),


@@ -244,7 +244,7 @@ smx_synchro_t simcall_HANDLER_comm_isend(smx_simcall_t simcall, smx_process_t sr
   return (detached ? NULL : other_comm);
 }
 
   return (detached ? NULL : other_comm);
 }
 

-void simcall_HANDLER_comm_recv(smx_simcall_t simcall, smx_process_t receiver, smx_mailbox_t mbox,
+XBT_PRIVATE void simcall_HANDLER_comm_recv(smx_simcall_t simcall, smx_process_t receiver, smx_mailbox_t mbox,

                          void *dst_buff, size_t *dst_buff_size,
                          int (*match_fun)(void *, void *, smx_synchro_t),
                          void (*copy_data_fun)(smx_synchro_t, void*, size_t),
                          void *dst_buff, size_t *dst_buff_size,
                          int (*match_fun)(void *, void *, smx_synchro_t),
                          void (*copy_data_fun)(smx_synchro_t, void*, size_t),


@@ -255,7 +255,7 @@ void simcall_HANDLER_comm_recv(smx_simcall_t simcall, smx_process_t receiver, sm
   simcall_HANDLER_comm_wait(simcall, comm, timeout);
 }
 
   simcall_HANDLER_comm_wait(simcall, comm, timeout);
 }
 

-smx_synchro_t simcall_HANDLER_comm_irecv(smx_simcall_t simcall, smx_process_t receiver, smx_mailbox_t mbox,
+XBT_PRIVATE smx_synchro_t simcall_HANDLER_comm_irecv(smx_simcall_t simcall, smx_process_t receiver, smx_mailbox_t mbox,

     void *dst_buff, size_t *dst_buff_size,
     int (*match_fun)(void *, void *, smx_synchro_t),
     void (*copy_data_fun)(smx_synchro_t, void*, size_t),
     void *dst_buff, size_t *dst_buff_size,
     int (*match_fun)(void *, void *, smx_synchro_t),
     void (*copy_data_fun)(smx_synchro_t, void*, size_t),