Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
doc: fix an issue spotted by find-missing.py
authorMartin Quinson <martin.quinson@ens-rennes.fr>
Fri, 9 Jul 2021 23:38:13 +0000 (01:38 +0200)
committerMartin Quinson <martin.quinson@ens-rennes.fr>
Fri, 9 Jul 2021 23:38:46 +0000 (01:38 +0200)
docs/find-missing.ignore
docs/source/app_s4u.rst
include/simgrid/forward.h

index d4501ef..7fb7732 100644 (file)
@@ -180,7 +180,6 @@ member ::msg_error_t is of kind enum
 
 # These ones are a bug of Doxygen, that parse them as variables instead of types.
 # So we don't use this bogus parse result, but go directly for cpp:type directives in app_s4u.rst
-.. autodoxyvar:: ::const_sg_actor_t
 .. autodoxyvar:: ::const_sg_bar_t
 .. autodoxyvar:: ::const_sg_mutex_t
 .. autodoxyvar:: ::const_sg_sem_t
index 93f5e51..cd7d1ab 100644 (file)
@@ -438,10 +438,7 @@ Basic management
          #include <simgrid/actor.h>
 
       .. doxygentypedef:: sg_actor_t
-      .. cpp:type:: const s4u_Actor* const_sg_actor_t
-
-         Pointer to a constant actor object.
-
+      .. doxygentypedef:: const_sg_actor_t
       .. doxygenfunction:: sg_actor_ref
       .. doxygenfunction:: sg_actor_unref
 
index 41ca22c..0d46aa6 100644 (file)
@@ -280,7 +280,9 @@ typedef s4u_File* sg_file_t;
 typedef const s4u_File* const_sg_file_t;
 typedef s4u_VM* sg_vm_t;
 typedef const s4u_VM* const_sg_vm_t;
+/** Pointer to an actor object */
 typedef s4u_Actor* sg_actor_t;
+/** Pointer to a constant actor object */
 typedef const s4u_Actor* const_sg_actor_t;
 
 typedef struct s_smx_simcall* smx_simcall_t;