]> git.tuebingen.mpg.de Git - paraslash.git/commitdiff
.
authorAndre Noll <maan@tuebingen.mpg.de>
Mon, 2 Jun 2025 22:35:37 +0000 (00:35 +0200)
committerAndre Noll <maan@tuebingen.mpg.de>
Tue, 10 Jun 2025 14:04:43 +0000 (16:04 +0200)
sched.h
web/documentation.in.html

diff --git a/sched.h b/sched.h
index 36391c4dbd213d65806bec4b9769ad776c211148..60c49cabc601aa11a61b47b803adc36a865569f9 100644 (file)
--- a/sched.h
+++ b/sched.h
@@ -42,7 +42,8 @@ struct sched {
 
 struct task;
 
-/** \par Information that must be supplied by callers of \ref task_register().
+/**
+ * Information that must be supplied by callers of \ref task_register().
  *
  * The structure may be safely discarded after the task has been registered.
  */
index e570c5f5744ae1d6ce934cb81051440b2c87ee77..61239b8f50a1a3fc91eeec6db579a8baccec1ad3 100644 (file)
 
 <h2> Source code documentation </h2>
 
-<p> All public functions and variables are documented, but static functions,
-structures and macros defined in .c files are not. Most source files contain
-additional comments not shown here which describe particular implementation
-details. </p>
+<p> All public functions and variables are documented, but static functions
+and variables are not, Most source files contain additional comments not
+shown here which describe particular implementation details. </p>
 
 <h3> Subsystems </h3>
 
 <p> To get started in a particular subsystem, follow one of the links
-below. Each link points to a header file which defines the public API of a
-paraslash subsystem. This selection is not exhaustive, though. </p>
+below, each of which describes the public API of a particular paraslash
+subsystem. This selection is not exhaustive, though. </p>
 
 <p>
        [<a href="doxygen/html/sched_8h.html">Scheduler</a>]
@@ -58,10 +57,10 @@ paraslash subsystem. This selection is not exhaustive, though. </p>
 <h3> Executables </h3>
 
 <p> The detailed description of each executable usually mentions relevant
-other object files which are linked into the executable. The comment of the
-main function talks about public functions defined elsewhere and called from
-this file. The comment also describes which tasks are created and registered
-to the paraslash scheduler. </p>
+other object files which are linked into the executable. The comment of
+the main function talks about public functions defined elsewhere and called
+from this file. The comment also describes the tasks which are created and
+registered to the paraslash scheduler. </p>
 
 <p>
        [<a href="doxygen/html/server_8c.html">para_server</a>]