From: Martin Quinson Date: Fri, 13 May 2016 09:48:19 +0000 (+0200) Subject: tweak the documentation rendering X-Git-Tag: v3_14~1236^2 X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/commitdiff_plain/4f866ed96a91b13a3dc0e4511361bb5071022542?hp=7b1285f5d7157668a18f0aac06ebaf69e4f34b1e tweak the documentation rendering --- diff --git a/doc/Doxyfile.in b/doc/Doxyfile.in index 832f055823..75a24f4afe 100644 --- 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. -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. diff --git a/doc/Layout.xml b/doc/Layout.xml index 585a480d76..eb71a76ae1 100644 --- a/doc/Layout.xml +++ b/doc/Layout.xml @@ -1,28 +1,18 @@ - - - - + + - - - - - + + @@ -160,7 +151,6 @@ - diff --git a/doc/doxygen/platform.doc b/doc/doxygen/platform.doc index e276c983f3..d8233b51a5 100644 --- 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 diff --git a/include/xbt/base.h b/include/xbt/base.h index 38f9308ec0..285c3f61c3 100644 --- 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_PRIVATE +# define XBT_PRIVATE /** @private */ #endif diff --git a/src/simix/popping_bodies.cpp b/src/simix/popping_bodies.cpp index b872bbbf8c..57e3e9aa4d 100644 --- 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 +/** @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(); @@ -1549,4 +1550,4 @@ inline static void simcall_BODY_run_kernel(void* code) { 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 c572811aad..806eb320a0 100644 --- 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",}; -/** +/** @private * @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 3bf49a5464..46c7101f85 100755 --- a/src/simix/simcalls.py +++ b/src/simix/simcalls.py @@ -323,7 +323,7 @@ if __name__ == '__main__': 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') @@ -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 \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() diff --git a/src/simix/smx_network.cpp b/src/simix/smx_network.cpp index 3db60d6ac4..c4e14645ff 100644 --- 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 *deque, e_smx /******************************************************************************/ /* 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), @@ -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); } -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), @@ -244,7 +244,7 @@ smx_synchro_t simcall_HANDLER_comm_isend(smx_simcall_t simcall, smx_process_t sr 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), @@ -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); } -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),