# 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_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.
<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="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="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"
<!-- Layout definition for a group page -->
<group>
+ <detaileddescription title=""/>
<briefdescription visible="yes"/>
<groupgraph visible="$GROUP_GRAPHS"/>
<memberdecl>
<friends title=""/>
<membergroups visible="yes"/>
</memberdecl>
- <detaileddescription title=""/>
<memberdef>
<pagedocs/>
<inlineclasses title=""/>
-/*! \page platform Describe the underlying platform
+/*! \page platform Describing the virtual platform
@tableofcontents
# 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
#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();
SIMIX_simcall_handle(&self->simcall, 0);
}
- }
\ No newline at end of file
+ }/** @endcond */
"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
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('#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)
+ fd.write("/** @endcond */\n");
fd.close()
/******************************************************************************/
/* 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),
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),
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),
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),