Skip to content

Commit

Permalink
chore: updated C docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@ntamas
ntamas committed Apr 9, 2024
1 parent 43ca13b commit d71ba69
Show file tree
Hide file tree
Showing 18 changed files with 2,360 additions and 2,339 deletions.
14 changes: 8 additions & 6 deletions docs/c/html/develop/igraph-Community.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3763,10 +3763,10 @@ <h1 class="display-4">igraph Reference Manual</h1>
at <a class="ulink" href="https://www.mapequation.org" target="_top">https://www.mapequation.org</a> . The original paper describing the algorithm
is: M. Rosvall and C. T. Bergstrom, Maps of information flow reveal community
structure in complex networks, PNAS 105, 1118 (2008)
(<a class="ulink" href="http://dx.doi.org/10.1073/pnas.0706851105" target="_top">http://dx.doi.org/10.1073/pnas.0706851105</a>, <a class="ulink" href="http://arxiv.org/abs/0707.0609" target="_top">http://arxiv.org/abs/0707.0609</a>).
(<a class="ulink" href="https://dx.doi.org/10.1073/pnas.0706851105" target="_top">https://dx.doi.org/10.1073/pnas.0706851105</a>, <a class="ulink" href="https://arxiv.org/abs/0707.0609" target="_top">https://arxiv.org/abs/0707.0609</a>).
A more detailed paper about the algorithm is: M. Rosvall, D. Axelsson, and
C. T. Bergstrom, The map equation, Eur. Phys. J. Special Topics 178, 13 (2009).
(<a class="ulink" href="http://dx.doi.org/10.1140/epjst/e2010-01179-1" target="_top">http://dx.doi.org/10.1140/epjst/e2010-01179-1</a>, <a class="ulink" href="http://arxiv.org/abs/0906.1405" target="_top">http://arxiv.org/abs/0906.1405</a>)
(<a class="ulink" href="https://dx.doi.org/10.1140/epjst/e2010-01179-1" target="_top">https://dx.doi.org/10.1140/epjst/e2010-01179-1</a>, <a class="ulink" href="https://arxiv.org/abs/0906.1405" target="_top">https://arxiv.org/abs/0906.1405</a>)

</p>
<p>
Expand Down Expand Up @@ -3896,7 +3896,8 @@ <h1 class="display-4">igraph Reference Manual</h1>
<div class="informalexample"><pre class="programlisting">
igraph_error_t igraph_community_voronoi(
const igraph_t *graph,
igraph_vector_int_t *membership, igraph_vector_int_t *generators, igraph_real_t *modularity,
igraph_vector_int_t *membership, igraph_vector_int_t *generators,
igraph_real_t *modularity,
const igraph_vector_t *lengths, const igraph_vector_t *weights,
igraph_neimode_t mode, igraph_real_t r);
</pre></div>
Expand Down Expand Up @@ -3929,14 +3930,15 @@ <h3 class="title">Warning</h3>

</p>
<p>
Deritei et al, Community detection by graph Voronoi diagrams,
Deritei et al., Community detection by graph Voronoi diagrams,
New Journal of Physics 16, 063007 (2014)
<a class="ulink" href="https://doi.org/10.1088/1367-2630/16/6/063007" target="_top">https://doi.org/10.1088/1367-2630/16/6/063007</a>

</p>
<p>
Molnár et al, Community Detection in Directed Weighted Networks using Voronoi Partitioning,
<a class="ulink" href="https://arxiv.org/abs/2304.12389" target="_top">https://arxiv.org/abs/2304.12389</a>
Molnár et al., Community Detection in Directed Weighted Networks using Voronoi Partitioning,
Scientific Reports 14, 8124 (2024)
<a class="ulink" href="https://doi.org/10.1038/s41598-024-58624-4" target="_top">https://doi.org/10.1038/s41598-024-58624-4</a>

</p>
<p><b>Arguments: </b>
Expand Down
58 changes: 28 additions & 30 deletions docs/c/html/develop/igraph-Error.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -216,8 +216,8 @@ <h1 class="display-4">igraph Reference Manual</h1>
<div class="titlepage"><div><div><h3 class="title">
<a name="igraph_error_handler_t"></a>2.1. <code class="function">igraph_error_handler_t</code> — The type of error handler functions.</h3></div></div></div>
<a class="indexterm" name="id-1.6.3.7.2"></a><pre class="programlisting">
typedef void igraph_error_handler_t (const char *reason, const char *file,
int line, igraph_error_t igraph_errno);
typedef void igraph_error_handler_t(const char *reason, const char *file,
int line, igraph_error_t igraph_errno);
</pre>
<p>

Expand Down Expand Up @@ -270,7 +270,7 @@ <h1 class="display-4">igraph Reference Manual</h1>
<a class="indexterm" name="id-1.6.3.8.2"></a><p>
</p>
<pre class="programlisting">
IGRAPH_EXPORT igraph_error_handler_t igraph_error_handler_abort;
igraph_error_handler_t igraph_error_handler_abort;
</pre>
<p>
</p>
Expand All @@ -288,7 +288,7 @@ <h1 class="display-4">igraph Reference Manual</h1>
<a class="indexterm" name="id-1.6.3.9.2"></a><p>
</p>
<pre class="programlisting">
IGRAPH_EXPORT igraph_error_handler_t igraph_error_handler_ignore;
igraph_error_handler_t igraph_error_handler_ignore;
</pre>
<p>
</p>
Expand All @@ -306,7 +306,7 @@ <h1 class="display-4">igraph Reference Manual</h1>
<a class="indexterm" name="id-1.6.3.10.2"></a><p>
</p>
<pre class="programlisting">
IGRAPH_EXPORT igraph_error_handler_t igraph_error_handler_printignore;
igraph_error_handler_t igraph_error_handler_printignore;
</pre>
<p>
</p>
Expand Down Expand Up @@ -686,7 +686,7 @@ <h1 class="display-4">igraph Reference Manual</h1>
<a class="indexterm" name="id-1.6.4.5.2"></a><p>
</p>
<div class="informalexample"><pre class="programlisting">
const char* igraph_strerror(const igraph_error_t igraph_errno);
const char *igraph_strerror(const igraph_error_t igraph_errno);
</pre></div>
<p>
</p>
Expand Down Expand Up @@ -768,7 +768,8 @@ <h1 class="display-4">igraph Reference Manual</h1>
<div class="titlepage"><div><div><h3 class="title">
<a name="igraph_warning_handler_t"></a>4.1. <code class="function">igraph_warning_handler_t</code> — The type of igraph warning handler functions.</h3></div></div></div>
<a class="indexterm" name="id-1.6.5.5.2"></a><pre class="programlisting">
typedef void igraph_warning_handler_t (const char *reason, const char *file, int line);
typedef void igraph_warning_handler_t(const char *reason,
const char *file, int line);
</pre>
<p>

Expand All @@ -785,7 +786,7 @@ <h1 class="display-4">igraph Reference Manual</h1>
<a class="indexterm" name="id-1.6.5.6.2"></a><p>
</p>
<div class="informalexample"><pre class="programlisting">
igraph_warning_handler_t* igraph_set_warning_handler(igraph_warning_handler_t* new_handler);
igraph_warning_handler_t *igraph_set_warning_handler(igraph_warning_handler_t *new_handler);
</pre></div>
<p>
</p>
Expand Down Expand Up @@ -871,7 +872,7 @@ <h1 class="display-4">igraph Reference Manual</h1>
<a class="indexterm" name="id-1.6.5.8.2"></a><p>
</p>
<pre class="programlisting">
#define IGRAPH_WARNINGF
#define IGRAPH_WARNINGF(reason, ...)
</pre>
<p>
</p>
Expand Down Expand Up @@ -917,7 +918,7 @@ <h1 class="display-4">igraph Reference Manual</h1>
<a class="indexterm" name="id-1.6.5.9.2"></a><p>
</p>
<div class="informalexample"><pre class="programlisting">
void igraph_warning(const char *reason, const char *file, int line);
void igraph_warning(const char *reason, const char *file, int line);
</pre></div>
<p>
</p>
Expand Down Expand Up @@ -990,8 +991,7 @@ <h1 class="display-4">igraph Reference Manual</h1>
<a class="indexterm" name="id-1.6.5.10.2"></a><p>
</p>
<div class="informalexample"><pre class="programlisting">
IGRAPH_FUNCATTR_PRINTFLIKE(1,4)
IGRAPH_EXPORT void igraph_warningf(const char *reason, const char *file, int line, ...);
void igraph_warningf(const char *reason, const char *file, int line, ...);
</pre></div>
<p>
</p>
Expand Down Expand Up @@ -1219,7 +1219,7 @@ <h1 class="display-4">igraph Reference Manual</h1>
<a class="indexterm" name="id-1.6.6.2.6.2"></a><p>
</p>
<div class="informalexample"><pre class="programlisting">
igraph_error_handler_t* igraph_set_error_handler(igraph_error_handler_t* new_handler);
igraph_error_handler_t *igraph_set_error_handler(igraph_error_handler_t *new_handler);
</pre></div>
<p>
</p>
Expand Down Expand Up @@ -1344,7 +1344,7 @@ <h1 class="display-4">igraph Reference Manual</h1>
<a class="indexterm" name="id-1.6.6.3.4.2"></a><p>
</p>
<pre class="programlisting">
#define IGRAPH_ERRORF
#define IGRAPH_ERRORF(reason, igraph_errno, ...)
</pre>
<p>
</p>
Expand Down Expand Up @@ -1405,8 +1405,8 @@ <h1 class="display-4">igraph Reference Manual</h1>
<a class="indexterm" name="id-1.6.6.3.5.2"></a><p>
</p>
<div class="informalexample"><pre class="programlisting">
igraph_error_t igraph_error(const char *reason, const char *file, int line,
igraph_error_t igraph_errno);
igraph_error_t igraph_error(const char *reason, const char *file, int line,
igraph_error_t igraph_errno);
</pre></div>
<p>
</p>
Expand Down Expand Up @@ -1482,7 +1482,7 @@ <h1 class="display-4">igraph Reference Manual</h1>
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code></code></em></span></p></td>
<td><p>
igraph_errorf().
<a class="link" href="igraph-Error.html#igraph_errorf" title="5.2.4. igraph_errorf — Reports an error, printf-like version."><code class="function">igraph_errorf()</code></a>
</p></td>
</tr></tbody>
</table></div>
Expand All @@ -1496,9 +1496,8 @@ <h1 class="display-4">igraph Reference Manual</h1>
<a class="indexterm" name="id-1.6.6.3.6.2"></a><p>
</p>
<div class="informalexample"><pre class="programlisting">
IGRAPH_FUNCATTR_PRINTFLIKE(1,5)
IGRAPH_EXPORT igraph_error_t igraph_errorf(const char *reason, const char *file, int line,
igraph_error_t igraph_errno, ...);
igraph_error_t igraph_errorf(const char *reason, const char *file, int line,
igraph_error_t igraph_errno, ...);
</pre></div>
<p>
</p>
Expand Down Expand Up @@ -1561,7 +1560,7 @@ <h1 class="display-4">igraph Reference Manual</h1>
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code></code></em></span></p></td>
<td><p>
igraph_error().
<a class="link" href="igraph-Error.html#igraph_error" title="5.2.3. igraph_error — Reports an error."><code class="function">igraph_error()</code></a>
</p></td>
</tr></tbody>
</table></div>
Expand Down Expand Up @@ -1752,7 +1751,7 @@ <h1 class="display-4">igraph Reference Manual</h1>
<a class="indexterm" name="id-1.6.6.4.4.2"></a><p>
</p>
<div class="informalexample"><pre class="programlisting">
void IGRAPH_FINALLY_CLEAN(int num);
void IGRAPH_FINALLY_CLEAN(int num);
</pre></div>
<p>
</p>
Expand Down Expand Up @@ -1801,7 +1800,7 @@ <h1 class="display-4">igraph Reference Manual</h1>
<a class="indexterm" name="id-1.6.6.4.5.2"></a><p>
</p>
<div class="informalexample"><pre class="programlisting">
void IGRAPH_FINALLY_FREE(void);
void IGRAPH_FINALLY_FREE(void);
</pre></div>
<p>
</p>
Expand Down Expand Up @@ -1883,7 +1882,7 @@ <h1 class="display-4">igraph Reference Manual</h1>
<div class="titlepage"><div><div><h4 class="title">
<a name="igraph_fatal_handler_t"></a>5.5.1. <code class="function">igraph_fatal_handler_t</code> — The type of igraph fatal error handler functions.</h4></div></div></div>
<a class="indexterm" name="id-1.6.6.6.5.2"></a><pre class="programlisting">
typedef void igraph_fatal_handler_t (const char *reason, const char *file, int line);
typedef void igraph_fatal_handler_t(const char *reason, const char *file, int line);
</pre>
<p>

Expand Down Expand Up @@ -1930,7 +1929,7 @@ <h1 class="display-4">igraph Reference Manual</h1>
<a class="indexterm" name="id-1.6.6.6.6.2"></a><p>
</p>
<div class="informalexample"><pre class="programlisting">
igraph_fatal_handler_t* igraph_set_fatal_handler(igraph_fatal_handler_t* new_handler);
igraph_fatal_handler_t *igraph_set_fatal_handler(igraph_fatal_handler_t *new_handler);
</pre></div>
<p>
</p>
Expand Down Expand Up @@ -1987,7 +1986,7 @@ <h1 class="display-4">igraph Reference Manual</h1>
<a class="indexterm" name="id-1.6.6.6.7.2"></a><p>
</p>
<pre class="programlisting">
IGRAPH_EXPORT igraph_fatal_handler_t igraph_fatal_handler_abort;
igraph_fatal_handler_t igraph_fatal_handler_abort;
</pre>
<p>
</p>
Expand Down Expand Up @@ -2044,7 +2043,7 @@ <h1 class="display-4">igraph Reference Manual</h1>
<a class="indexterm" name="id-1.6.6.6.9.2"></a><p>
</p>
<pre class="programlisting">
#define IGRAPH_FATALF
#define IGRAPH_FATALF(reason, ...)
</pre>
<p>
</p>
Expand Down Expand Up @@ -2142,7 +2141,7 @@ <h1 class="display-4">igraph Reference Manual</h1>
<a class="indexterm" name="id-1.6.6.6.11.2"></a><p>
</p>
<div class="informalexample"><pre class="programlisting">
IGRAPH_FUNCATTR_NORETURN void igraph_fatal(const char *reason, const char *file, int line);
void igraph_fatal(const char *reason, const char *file, int line);
</pre></div>
<p>
</p>
Expand Down Expand Up @@ -2192,8 +2191,7 @@ <h1 class="display-4">igraph Reference Manual</h1>
<a class="indexterm" name="id-1.6.6.6.12.2"></a><p>
</p>
<div class="informalexample"><pre class="programlisting">
IGRAPH_FUNCATTR_PRINTFLIKE(1,4)
IGRAPH_EXPORT IGRAPH_FUNCATTR_NORETURN void igraph_fatalf(const char *reason, const char *file, int line, ...);
void igraph_fatalf(const char *reason, const char *file, int line, ...);
</pre></div>
<p>
</p>
Expand Down
Loading

0 comments on commit d71ba69

Please sign in to comment.