chore: updated C docs

Author: ntamas

c/html/develop/igraph-Advanced.html

@@ -422,7 +422,7 @@
 <p>
 
 
-This is the more flexible version of <a class="link" href="igraph-Advanced.html#IGRAPH_PROGRESSF" title="2.3.2. IGRAPH_PROGRESSF — Report the progress of a calculation from an igraph function, printf-like (macro variant)."><code class="function">IGRAPH_PROGRESSF()</code></a>,
+This is the more flexible version of <a class="link" href="igraph-Advanced.html#IGRAPH_PROGRESS" title="2.3.1. IGRAPH_PROGRESS — Report the progress of a calculation from an igraph function (macro variant)."><code class="function">IGRAPH_PROGRESS()</code></a>,
 having a printf-like syntax. As this macro takes variable
 number of arguments, they must be all supplied as a single
 argument, enclosed in parentheses. <a class="link" href="igraph-Advanced.html#igraph_progressf" title="2.3.4. igraph_progressf — Report the progress of a calculation from an igraph function, printf-like."><code class="function">igraph_progressf()</code></a> is then

c/html/develop/igraph-Arpack.html

@@ -90,19 +90,34 @@
 <tr>
 <td><p><span class="term"><em class="parameter"><code>res</code></em>:</span></p></td>
 <td><p>
-  Pointer to a real, the result will be stored here.</p></td>
+  Pointer to a real, the result will be stored here.
+</p></td>
 </tr>
 </tbody>
 </table></div>
 <p>
-
+</p>
+<p><b>Returns: </b></p>
+<div class="variablelist"><table border="0" class="variablelist">
+<colgroup>
+<col align="left" valign="top">
+<col>
+</colgroup>
+<tbody><tr>
+<td><p><span class="term"><em class="parameter"><code></code></em></span></p></td>
+<td><p>
+  Error code.
+  </p></td>
+</tr></tbody>
+</table></div>
+<p>
 
 Time complexity: O(n) where n is the length of the vectors.
 
 </p>
 <div class="hideshow" onClick="toggle(this, event)">
 <div class="example">
-<a name="id-1.30.2.3.6.1"></a><p class="title"><b>Example 29.1.  File <code class="code">examples/simple/blas.c</code></b></p>
+<a name="id-1.30.2.3.8.1"></a><p class="title"><b>Example 29.1.  File <code class="code">examples/simple/blas.c</code></b></p>
 <div class="example-contents">
 <pre class="programlisting"><span class="strong"><strong>#include</strong></span> &lt;igraph.h&gt;
 
@@ -1074,7 +1089,7 @@
 
 
 Calls the DSYEVR LAPACK function to compute selected eigenvalues
-and, optionally, eigenvectors of a real symmetric matrix A.
+and, optionally, eigenvectors of a real symmetric matrix <code class="constant">A</code>.
 Eigenvalues and eigenvectors can be selected by specifying either
 a range of values or a range of indices for the desired eigenvalues.
 
@@ -1106,7 +1121,7 @@
        the corresponding eigenvectors) to calculate. Possible
        values are <code class="constant">IGRAPH_LAPACK_DSYEV_ALL</code>, all eigenvalues;
        <code class="constant">IGRAPH_LAPACK_DSYEV_INTERVAL</code>, all eigenvalues in the
-       half-open interval (vl,vu];
+       half-open interval <code class="literal">(vl, vu]</code>;
        <code class="constant">IGRAPH_LAPACK_DSYEV_SELECT</code>, the il-th through iu-th
        eigenvalues.
 </p></td>
@@ -1131,7 +1146,7 @@
 <td><p><span class="term"><em class="parameter"><code>vestimate</code></em>:</span></p></td>
 <td><p>
   An upper bound for the number of eigenvalues in
-       the (vl,vu] interval, if <em class="parameter"><code>which</code></em> is <code class="constant">IGRAPH_LAPACK_DSYEV_INTERVAL</code>. Memory is allocated only for
+       the <code class="literal">(vl, vu]</code> interval, if <em class="parameter"><code>which</code></em> is <code class="constant">IGRAPH_LAPACK_DSYEV_INTERVAL</code>. Memory is allocated only for
        the given number of eigenvalues (and eigenvectors), so this
        upper bound must be correct.
 </p></td>
@@ -1153,9 +1168,9 @@
 <td><p>
   The absolute error tolerance for the eigevalues. An
        approximate eigenvalue is accepted as converged when it is
-       determined to lie in an interval [a,b] of width less than or
-       equal to abstol + EPS * max(|a|,|b|), where EPS is the
-       machine precision.
+       determined to lie in an interval <code class="literal">[a,b]</code> of width
+       less than or equal to <code class="literal">abstol + EPS * max(|a|,|b|)</code>,
+       where <code class="constant">EPS</code> is the machine precision.
 </p></td>
 </tr>
 <tr>
@@ -1169,8 +1184,8 @@
 <tr>
 <td><p><span class="term"><em class="parameter"><code>vectors</code></em>:</span></p></td>
 <td><p>
-  An initialized matrix, the eigenvectors are stored
-       in its columns, unless it is a null pointer. It will be
+  An initialized matrix. A set of orthonormal eigenvectors
+       are stored in its columns, unless it is a null pointer. It will be
        resized as needed.
 </p></td>
 </tr>

c/html/develop/igraph-Attributes.html

@@ -232,7 +232,7 @@
 <td><p>
   Called when new edges are added to a graph, after the
    base data structure was modified. A vector containing the endpoints of the
-   new edges are supplied as an argument. The function is supposd to set up
+   new edges are supplied as an argument. The function is supposed to set up
    default values for each edge attribute that is currently registered on the
    graph, for all the newly added edges. Expected to return an error code.
 </p></td>
@@ -245,7 +245,7 @@
    attributes of some edges from the old graph (this also includes the
    deletion of edges). The supplied index vector defines which old edge a new
    edge corresponds to. Its length is the same as the number of edges in the
-   new graph, and for each edge it provides the ID of the correspnding edge
+   new graph, and for each edge it provides the ID of the corresponding edge
    in the old graph. The function is supposed to set up the values of the
    edge attributes of the new graph based on the attributes of the old graph
    and the provided index vector. Note that the old and the new graph <span class="emphasis"><em>may</em></span>
@@ -1253,7 +1253,7 @@
 a single one. Attribute combination lists are used to indicate to the attribute
 handler how to combine the attributes of the original vertices or edges and
 how to derive the final attribute value that is to be assigned to the collapsed
-vertex or edge. For example, <a class="link" href="igraph-Operators.html#igraph_simplify" title="3.9. igraph_simplify — Removes loop and/or multiple edges from the graph."><code class="function">igraph_simplify()</code></a> removes loops and combines
+vertex or edge. For example, <a class="link" href="igraph-Operators.html#igraph_simplify" title="3.10. igraph_simplify — Removes loop and/or multiple edges from the graph."><code class="function">igraph_simplify()</code></a> removes loops and combines
 multiple edges into a single one; in case of a graph with an edge attribute
 named <code class="constant">weight</code> the attribute combination list can tell the attribute handler
 whether the weight of a collapsed edge should be the sum, the mean or some other
@@ -1722,7 +1722,7 @@
                                  "type",   IGRAPH_ATTRIBUTE_COMBINE_FIRST,
                                  "",       IGRAPH_ATTRIBUTE_COMBINE_IGNORE,
                                  IGRAPH_NO_MORE_ATTRIBUTES);
-    <span class="strong"><strong><a class="link" href="igraph-Operators.html#igraph_simplify" title="3.9. igraph_simplify — Removes loop and/or multiple edges from the graph.">igraph_simplify</a></strong></span>(&amp;graph, <span class="emphasis"><em>/*remove_multiple=*/</em></span> true, <span class="emphasis"><em>/*remove_loops=*/</em></span> true, &amp;comb);
+    <span class="strong"><strong><a class="link" href="igraph-Operators.html#igraph_simplify" title="3.10. igraph_simplify — Removes loop and/or multiple edges from the graph.">igraph_simplify</a></strong></span>(&amp;graph, <span class="emphasis"><em>/*remove_multiple=*/</em></span> true, <span class="emphasis"><em>/*remove_loops=*/</em></span> true, &amp;comb);
     <span class="strong"><strong><a class="link" href="igraph-Foreign.html#igraph_write_graph_graphml" title="3.2. igraph_write_graph_graphml — Writes the graph to a file in GraphML format.">igraph_write_graph_graphml</a></strong></span>(&amp;graph, stdout, <span class="emphasis"><em>/*prefixattr=*/</em></span> true);
 
     <span class="strong"><strong><a class="link" href="igraph-Basic.html#igraph_destroy" title="4.1.4. igraph_destroy — Frees the memory allocated for a graph object.">igraph_destroy</a></strong></span>(&amp;graph);
@@ -1920,7 +1920,7 @@
     <span class="strong"><strong><a class="link" href="igraph-Attributes.html#igraph_set_attribute_table" title="1.2. igraph_set_attribute_table — Attach an attribute table.">igraph_set_attribute_table</a></strong></span>(&amp;igraph_cattribute_table);
 
     <span class="emphasis"><em>/* Create a graph, add some attributes and save it as a GraphML file. */</em></span>
-    <span class="strong"><strong><a class="link" href="igraph-Generators.html#igraph_famous" title="1.25. igraph_famous — Create a famous graph by simply providing its name.">igraph_famous</a></strong></span>(&amp;g, "Petersen");
+    <span class="strong"><strong><a class="link" href="igraph-Generators.html#igraph_famous" title="1.27. igraph_famous — Create a famous graph by simply providing its name.">igraph_famous</a></strong></span>(&amp;g, "Petersen");
     <span class="strong"><strong><a class="link" href="igraph-Attributes.html#SETGAS" title="4.2.6. SETGAS — Set a string graph attribute">SETGAS</a></strong></span>(&amp;g, "name", "Petersen's graph");
     <span class="strong"><strong><a class="link" href="igraph-Attributes.html#SETGAN" title="4.2.2. SETGAN — Set a numeric graph attribute">SETGAN</a></strong></span>(&amp;g, "vertices", <span class="strong"><strong><a class="link" href="igraph-Basic.html#igraph_vcount" title="4.2.1. igraph_vcount — The number of vertices in a graph.">igraph_vcount</a></strong></span>(&amp;g));
     <span class="strong"><strong><a class="link" href="igraph-Attributes.html#SETGAN" title="4.2.2. SETGAN — Set a numeric graph attribute">SETGAN</a></strong></span>(&amp;g, "edges", <span class="strong"><strong><a class="link" href="igraph-Basic.html#igraph_ecount" title="4.2.2. igraph_ecount — The number of edges in a graph.">igraph_ecount</a></strong></span>(&amp;g));
@@ -1976,7 +1976,7 @@
 }
 
 <span class="strong"><strong>static</strong></span> void <span class="strong"><strong>simplify_write_destroy</strong></span>(igraph_t *g, igraph_attribute_combination_t *comb) {
-    <span class="strong"><strong><a class="link" href="igraph-Operators.html#igraph_simplify" title="3.9. igraph_simplify — Removes loop and/or multiple edges from the graph.">igraph_simplify</a></strong></span>(g, <span class="emphasis"><em>/*remove_multiple=*/</em></span> true, <span class="emphasis"><em>/*remove_loops=*/</em></span> true, comb);
+    <span class="strong"><strong><a class="link" href="igraph-Operators.html#igraph_simplify" title="3.10. igraph_simplify — Removes loop and/or multiple edges from the graph.">igraph_simplify</a></strong></span>(g, <span class="emphasis"><em>/*remove_multiple=*/</em></span> true, <span class="emphasis"><em>/*remove_loops=*/</em></span> true, comb);
     <span class="strong"><strong><a class="link" href="igraph-Foreign.html#igraph_write_graph_graphml" title="3.2. igraph_write_graph_graphml — Writes the graph to a file in GraphML format.">igraph_write_graph_graphml</a></strong></span>(g, stdout, <span class="emphasis"><em>/*prefixattr=*/</em></span> true);
     <span class="strong"><strong><a class="link" href="igraph-Attributes.html#igraph_attribute_combination_destroy" title="3.4. igraph_attribute_combination_destroy — Destroy attribute combination list.">igraph_attribute_combination_destroy</a></strong></span>(comb);
     <span class="strong"><strong><a class="link" href="igraph-Basic.html#igraph_destroy" title="4.1.4. igraph_destroy — Frees the memory allocated for a graph object.">igraph_destroy</a></strong></span>(g);
@@ -2055,7 +2055,7 @@
 <pre class="programlisting"><span class="strong"><strong>#include</strong></span> &lt;igraph.h&gt;
 
 <span class="strong"><strong>static</strong></span> void <span class="strong"><strong>simplify_write_destroy</strong></span>(igraph_t *g, igraph_attribute_combination_t *comb) {
-    <span class="strong"><strong><a class="link" href="igraph-Operators.html#igraph_simplify" title="3.9. igraph_simplify — Removes loop and/or multiple edges from the graph.">igraph_simplify</a></strong></span>(g, <span class="emphasis"><em>/*remove_multiple=*/</em></span> true, <span class="emphasis"><em>/*remove_loops=*/</em></span> true, comb);
+    <span class="strong"><strong><a class="link" href="igraph-Operators.html#igraph_simplify" title="3.10. igraph_simplify — Removes loop and/or multiple edges from the graph.">igraph_simplify</a></strong></span>(g, <span class="emphasis"><em>/*remove_multiple=*/</em></span> true, <span class="emphasis"><em>/*remove_loops=*/</em></span> true, comb);
     <span class="strong"><strong><a class="link" href="igraph-Foreign.html#igraph_write_graph_graphml" title="3.2. igraph_write_graph_graphml — Writes the graph to a file in GraphML format.">igraph_write_graph_graphml</a></strong></span>(g, stdout, <span class="emphasis"><em>/*prefixattr=*/</em></span> true);
     <span class="strong"><strong><a class="link" href="igraph-Attributes.html#igraph_attribute_combination_destroy" title="3.4. igraph_attribute_combination_destroy — Destroy attribute combination list.">igraph_attribute_combination_destroy</a></strong></span>(comb);
     <span class="strong"><strong><a class="link" href="igraph-Basic.html#igraph_destroy" title="4.1.4. igraph_destroy — Frees the memory allocated for a graph object.">igraph_destroy</a></strong></span>(g);
@@ -4307,7 +4307,7 @@
 </p></td>
 </tr>
 <tr>
-<td><p><span class="term"><em class="parameter"><code>vids</code></em>:</span></p></td>
+<td><p><span class="term"><em class="parameter"><code>eids</code></em>:</span></p></td>
 <td><p>
   The edges to query.
 </p></td>

c/html/develop/igraph-Basic.html

@@ -99,7 +99,7 @@
 will check their input and issue an error if it is not valid. Those
 rare functions which do not perform this check clearly indicate this
 in their documentation. To eliminate multiple edges from a graph, you can use
-<a class="link" href="igraph-Operators.html#igraph_simplify" title="3.9. igraph_simplify — Removes loop and/or multiple edges from the graph.">
+<a class="link" href="igraph-Operators.html#igraph_simplify" title="3.10. igraph_simplify — Removes loop and/or multiple edges from the graph.">
   <code class="function">igraph_simplify()</code></a>.
 </p>
 </div>
@@ -1617,7 +1617,7 @@
                         IGRAPH_UNDIRECTED, <span class="emphasis"><em>/*unconn=*/</em></span> true);
         <span class="strong"><strong>igraph_vector_int_update</strong></span>(&amp;pairs, &amp;path);
         <span class="strong"><strong><a class="link" href="igraph-Basic.html#igraph_expand_path_to_pairs" title='5.3. igraph_expand_path_to_pairs — Helper function to convert a sequence of vertex IDs describing a path into a "pairs" vector.'>igraph_expand_path_to_pairs</a></strong></span>(&amp;pairs);
-        <span class="strong"><strong><a class="link" href="igraph-Basic.html#igraph_get_eids" title="4.2.10. igraph_get_eids — Return edge IDs based on the adjacent vertices.">igraph_get_eids</a></strong></span>(&amp;g, &amp;eids, &amp;pairs, 0, <span class="emphasis"><em>/*error=*/</em></span> true);
+        <span class="strong"><strong><a class="link" href="igraph-Basic.html#igraph_get_eids" title="4.2.10. igraph_get_eids — Return edge IDs based on the adjacent vertices.">igraph_get_eids</a></strong></span>(&amp;g, &amp;eids, &amp;pairs, <span class="emphasis"><em>/* directed= */</em></span> false, <span class="emphasis"><em>/*error=*/</em></span> true);
         <span class="strong"><strong>for</strong></span> (e = 0; e &lt; <span class="strong"><strong>igraph_vector_int_size</strong></span>(&amp;path) - 1; e++) {
             igraph_integer_t edge = <span class="strong"><strong><a class="link" href="igraph-Data-structures.html#VECTOR" title="2.4.1. VECTOR — Accessing an element of a vector.">VECTOR</a></strong></span>(eids)[e];
             igraph_integer_t from1 = <span class="strong"><strong><a class="link" href="igraph-Data-structures.html#VECTOR" title="2.4.1. VECTOR — Accessing an element of a vector.">VECTOR</a></strong></span>(path)[e];
@@ -2215,7 +2215,7 @@
     }
     <span class="strong"><strong><a class="link" href="igraph-Basic.html#igraph_destroy" title="4.1.4. igraph_destroy — Frees the memory allocated for a graph object.">igraph_destroy</a></strong></span>(&amp;g);
 
-    <span class="strong"><strong><a class="link" href="igraph-Generators.html#igraph_full" title="1.19. igraph_full — Creates a full graph (complete graph).">igraph_full</a></strong></span>(&amp;g, 10, IGRAPH_UNDIRECTED, IGRAPH_NO_LOOPS);
+    <span class="strong"><strong><a class="link" href="igraph-Generators.html#igraph_full" title="1.21. igraph_full — Creates a full graph (complete graph).">igraph_full</a></strong></span>(&amp;g, 10, IGRAPH_UNDIRECTED, IGRAPH_NO_LOOPS);
     <span class="strong"><strong><a class="link" href="igraph-Structural.html#igraph_maxdegree" title="10.10. igraph_maxdegree — The maximum degree in a graph (or set of vertices).">igraph_maxdegree</a></strong></span>(&amp;g, &amp;mdeg, <span class="strong"><strong><a class="link" href="igraph-Iterators.html#igraph_vss_all" title="4.1. igraph_vss_all — All vertices of a graph (immediate version).">igraph_vss_all</a></strong></span>(), IGRAPH_ALL, IGRAPH_LOOPS);
     <span class="strong"><strong>if</strong></span> (mdeg != 9) {
         <span class="strong"><strong>exit</strong></span>(7);
@@ -2410,7 +2410,7 @@
 </colgroup>
 <tbody>
 <tr>
-<td><p><span class="term"><em class="parameter"><code>igraph</code></em>:</span></p></td>
+<td><p><span class="term"><em class="parameter"><code>graph</code></em>:</span></p></td>
 <td><p>
   The graph.
 </p></td>

c/html/develop/igraph-Bipartite.html

@@ -299,8 +299,8 @@
 <tbody><tr>
 <td><p><span class="term"><em class="parameter"><code></code></em></span></p></td>
 <td><p>
-  <a class="link" href="igraph-Generators.html#igraph_full" title="1.19. igraph_full — Creates a full graph (complete graph)."><code class="function">igraph_full()</code></a> for non-bipartite complete graphs,
-<a class="link" href="igraph-Generators.html#igraph_full_multipartite" title="1.21. igraph_full_multipartite — Creates a full multipartite graph."><code class="function">igraph_full_multipartite()</code></a> for complete multipartite graphs.
+  <a class="link" href="igraph-Generators.html#igraph_full" title="1.21. igraph_full — Creates a full graph (complete graph)."><code class="function">igraph_full()</code></a> for non-bipartite complete graphs,
+<a class="link" href="igraph-Generators.html#igraph_full_multipartite" title="1.23. igraph_full_multipartite — Creates a full multipartite graph."><code class="function">igraph_full_multipartite()</code></a> for complete multipartite graphs.
   </p></td>
 </tr></tbody>
 </table></div>