Skip to content

Commit

Permalink
docs: generate documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
daynin authored and github-actions[bot] committed Mar 16, 2023
1 parent 374aa3e commit efbe80c
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 11 deletions.
2 changes: 1 addition & 1 deletion docs/configuration.html
Original file line number Diff line number Diff line change
Expand Up @@ -563,7 +563,7 @@ <h1 id="configuration"><a class="header" href="#configuration">Configuration</a>
If you wan't to turn fundoc on few lines below just add this comment: <code>fundoc-enable</code>.</p>
<p>In case when you don't write the enable-comment all text from disable comment until the end of
the file will be ignored
<a href="https://github.com/daynin/fundoc/blob/master/#L192-L198">[~]</a></p>
<a href="https://github.com/daynin/fundoc/blob/master/#L284-L290">[~]</a></p>

</main>

Expand Down
2 changes: 1 addition & 1 deletion docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -563,7 +563,7 @@ <h1 id="configuration"><a class="header" href="#configuration">Configuration</a>
If you wan't to turn fundoc on few lines below just add this comment: <code>fundoc-enable</code>.</p>
<p>In case when you don't write the enable-comment all text from disable comment until the end of
the file will be ignored
<a href="https://github.com/daynin/fundoc/blob/master/#L192-L198">[~]</a></p>
<a href="https://github.com/daynin/fundoc/blob/master/#L284-L290">[~]</a></p>

</main>

Expand Down
10 changes: 5 additions & 5 deletions docs/print.html
Original file line number Diff line number Diff line change
Expand Up @@ -564,7 +564,7 @@ <h1 id="configuration"><a class="header" href="#configuration">Configuration</a>
If you wan't to turn fundoc on few lines below just add this comment: <code>fundoc-enable</code>.</p>
<p>In case when you don't write the enable-comment all text from disable comment until the end of
the file will be ignored
<a href="https://github.com/daynin/fundoc/blob/master/#L192-L198">[~]</a></p>
<a href="https://github.com/daynin/fundoc/blob/master/#L284-L290">[~]</a></p>
<div style="break-before: page; page-break-before: always;"></div><h1 id="syntax"><a class="header" href="#syntax">Syntax</a></h1>
<p><code>@Article &lt;Article name&gt;</code> is for marking documentation sections to tell in which article this section should
be merged. You can use <code>markdown</code> syntax in documentation sections.</p>
Expand All @@ -577,7 +577,7 @@ <h1 id="configuration"><a class="header" href="#configuration">Configuration</a>
* Some text
*/
fn main() {}</code></pre></pre>
<p><a href="https://github.com/daynin/fundoc/blob/master/src/parser.rs#L34-L50">[~]</a></p>
<p><a href="https://github.com/daynin/fundoc/blob/master/src/parser.rs#L133-L149">[~]</a></p>
<p><code>@FileArticle</code> allows you to mark a whole file is a source of documentation for a specified
article.</p>
<p>Example:</p>
Expand Down Expand Up @@ -613,7 +613,7 @@ <h1 id="configuration"><a class="header" href="#configuration">Configuration</a>
* This comment will be ignored.
*/
fn parse_files() {}</code></pre></pre>
<p><a href="https://github.com/daynin/fundoc/blob/master/#L54-L98">[~]</a></p>
<p><a href="https://github.com/daynin/fundoc/blob/master/#L153-L197">[~]</a></p>
<p><code>@CodeBlockStart &lt;Programming Language&gt;</code> and <code>@CodeBlockEnd</code> allow to include code from a current file as an
example.</p>
<p>Example:</p>
Expand All @@ -629,9 +629,9 @@ <h1 id="configuration"><a class="header" href="#configuration">Configuration</a>
* @CodeBlockEnd
*/
<span class="boring">}</span></code></pre></pre>
<p><a href="https://github.com/daynin/fundoc/blob/master/#L102-L118">[~]</a></p>
<p><a href="https://github.com/daynin/fundoc/blob/master/#L201-L217">[~]</a></p>
<p><code>@Ignore</code> is for ignoring a marked documentation section.
<a href="https://github.com/daynin/fundoc/blob/master/#L123-L124">[~]</a></p>
<a href="https://github.com/daynin/fundoc/blob/master/#L222-L223">[~]</a></p>

</main>

Expand Down
8 changes: 4 additions & 4 deletions docs/syntax.html
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,7 @@ <h1 id="syntax"><a class="header" href="#syntax">Syntax</a></h1>
* Some text
*/
fn main() {}</code></pre></pre>
<p><a href="https://github.com/daynin/fundoc/blob/master/src/parser.rs#L34-L50">[~]</a></p>
<p><a href="https://github.com/daynin/fundoc/blob/master/src/parser.rs#L133-L149">[~]</a></p>
<p><code>@FileArticle</code> allows you to mark a whole file is a source of documentation for a specified
article.</p>
<p>Example:</p>
Expand Down Expand Up @@ -192,7 +192,7 @@ <h1 id="syntax"><a class="header" href="#syntax">Syntax</a></h1>
* This comment will be ignored.
*/
fn parse_files() {}</code></pre></pre>
<p><a href="https://github.com/daynin/fundoc/blob/master/#L54-L98">[~]</a></p>
<p><a href="https://github.com/daynin/fundoc/blob/master/#L153-L197">[~]</a></p>
<p><code>@CodeBlockStart &lt;Programming Language&gt;</code> and <code>@CodeBlockEnd</code> allow to include code from a current file as an
example.</p>
<p>Example:</p>
Expand All @@ -208,9 +208,9 @@ <h1 id="syntax"><a class="header" href="#syntax">Syntax</a></h1>
* @CodeBlockEnd
*/
<span class="boring">}</span></code></pre></pre>
<p><a href="https://github.com/daynin/fundoc/blob/master/#L102-L118">[~]</a></p>
<p><a href="https://github.com/daynin/fundoc/blob/master/#L201-L217">[~]</a></p>
<p><code>@Ignore</code> is for ignoring a marked documentation section.
<a href="https://github.com/daynin/fundoc/blob/master/#L123-L124">[~]</a></p>
<a href="https://github.com/daynin/fundoc/blob/master/#L222-L223">[~]</a></p>

</main>

Expand Down

0 comments on commit efbe80c

Please sign in to comment.