Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Make sure that the doc of the sg_actor functions land in the doc
authorMartin Quinson <martin.quinson@ens-rennes.fr>
Wed, 12 Feb 2020 10:29:20 +0000 (11:29 +0100)
committerMartin Quinson <martin.quinson@ens-rennes.fr>
Thu, 13 Feb 2020 16:49:00 +0000 (17:49 +0100)
At some point in the past, I came to the conclusion that I did not
want doxygen to introspect the implementation of the code but only the
header files. I think it was because I did not want doxygen to grab
and publish the internal symbols used for the implementation, but only
to document the public interface. I'm not entirely sure because it was
a long time ago :-/ Maybe I'm missing another issue that will resurface.

But this policy requires that the docstrings are in the header, while
good practices advise to keep docstrings close to the implem, to
increase the chance of getting them updated when the implem changes.

Now that we use autodoxy, we manually pick which symbols get
displayed, so it does not matter anymore to hide stuff from Doxygen as
when we had automatic content listing.

I don't feel (yet) like moving the docstrings from the headers back to
the implem a few years after moving them in the other direction, but
since the docstrings of the C implem is close to the implem (as it
should), let's show that implem to doxygen so that the C symbols get
documented in the refguide.

And yes. This documents a one line commit with 20+ lines of logs. This
will allow agier to point me to that commit when I change my mind in
the future ;) eg when the issue that I forgot will resurface.

docs/source/Doxyfile

index 70c58d5..50f9f92 100644 (file)
@@ -3,6 +3,7 @@ INPUT                  = ../../include/simgrid/forward.h
 INPUT                 += ../../include/simgrid/s4u
 INPUT                 += ../../include/simgrid/msg.h
 INPUT                 += ../../include/simgrid/actor.h
+INPUT                 += ../../src/s4u/s4u_Actor.cpp
 INPUT                 += ../../include/simgrid/barrier.h
 INPUT                 += ../../include/simgrid/cond.h
 INPUT                 += ../../include/simgrid/engine.h