Skip to content

Commit

Permalink
updated code documentation
Browse files Browse the repository at this point in the history 
FossilOrigin-Name: a372c578a07bdb62fce9cac599343b2a1c1bd5c3d4773132f1be8aed0d9a75d1
  • Loading branch information
@thindil
thindil committed Nov 17, 2019
1 parent 2eee789 commit 42ad1e4
Show file tree
Hide file tree
Showing 18 changed files with 478 additions and 254 deletions.
38 changes: 19 additions & 19 deletions docs/code/atomfeed_ads.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@
<link rel="stylesheet" href="./robodoc.css" type="text/css" />
<title>./src/atomfeed.ads</title>
<!-- Source: ./src/atomfeed.ads -->
<!-- Generated with ROBODoc Version 4.99.43 (Feb 2 2019) -->
<!-- Generated with ROBODoc Version 4.99.43 (Jul 26 2019) -->
</head>
<body>
<div id="logo">
<a name="robo_top_of_doc">YASS v1.1 code documentation</a>
<a name="robo_top_of_doc">YASS v2.0 code documentation</a>
</div> <!-- logo -->
<div id="navigation">
<a class="menuitem" href="./toc_index.html#top">Table of Contents</a>
Expand All @@ -30,13 +30,13 @@ <h3>TABLE OF CONTENTS</h3>
<ul>
<li>1. <a href="#robo0">Yass/AtomFeed</a></li>
<ul>
<li>1.1. <a href="#robo9">AtomFeed/FeedEntry</a></li>
<li>1.2. <a href="#robo10">AtomFeed/FeedEntry_Container</a></li>
<li>1.3. <a href="#robo21">AtomFeed/AddPageToFeed</a></li>
<li>1.4. <a href="#robo22">AtomFeed/SaveAtomFeed</a></li>
<li>1.5. <a href="#robo23">AtomFeed/StartAtomFeed</a></li>
<li>1.6. <a href="#robo24">AtomFeed/To_HTTP_Date</a></li>
<li>1.7. <a href="#robo25">AtomFeed/To_Time</a></li>
<li>1.1. <a href="#robo10">AtomFeed/FeedEntry</a></li>
<li>1.2. <a href="#robo11">AtomFeed/FeedEntry_Container</a></li>
<li>1.3. <a href="#robo23">AtomFeed/AddPageToFeed</a></li>
<li>1.4. <a href="#robo24">AtomFeed/SaveAtomFeed</a></li>
<li>1.5. <a href="#robo25">AtomFeed/StartAtomFeed</a></li>
<li>1.6. <a href="#robo26">AtomFeed/To_HTTP_Date</a></li>
<li>1.7. <a href="#robo27">AtomFeed/To_Time</a></li>
</ul>
</ul>
<hr />
Expand All @@ -53,7 +53,7 @@ <h3>TABLE OF CONTENTS</h3>

<hr />
<a name="AtomFeed2fFeedEntry"></a>
<a name="robo9"></a><h2>AtomFeed/FeedEntry [ Types ]</h2>
<a name="robo10"></a><h2>AtomFeed/FeedEntry [ Types ]</h2>

<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="#robo0">AtomFeed</a> ] [ <a href="./robo_types.html#robo_top_of_doc">Types</a> ]</p>
<p class="item_name">FUNCTION</p>
Expand Down Expand Up @@ -82,27 +82,27 @@ <h3>TABLE OF CONTENTS</h3>

<hr />
<a name="AtomFeed2fFeedEntry5fContainer"></a>
<a name="robo10"></a><h2>AtomFeed/FeedEntry_Container [ Types ]</h2>
<a name="robo11"></a><h2>AtomFeed/FeedEntry_Container [ Types ]</h2>

<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="#robo0">AtomFeed</a> ] [ <a href="./robo_types.html#robo_top_of_doc">Types</a> ]</p>
<p class="item_name">FUNCTION</p>
<pre> Used to store Atom feed entries
</pre>
<p class="item_name">SOURCE</p>
<pre class="source"> <span class="keyword">package</span> <strong>FeedEntry_Container</strong> <span class="keyword">is</span> <span class="keyword">new</span> Vectors<span class="sign">(</span>Positive<span class="sign">,</span> <a href="#robo9">FeedEntry</a><span class="sign">)</span><span class="sign">;</span>
<pre class="source"> <span class="keyword">package</span> <strong>FeedEntry_Container</strong> <span class="keyword">is</span> <span class="keyword">new</span> Vectors<span class="sign">(</span>Positive<span class="sign">,</span> <a href="#robo10">FeedEntry</a><span class="sign">)</span><span class="sign">;</span>
</pre>

<hr />
<a name="AtomFeed2fAddPageToFeed"></a>
<a name="robo21"></a><h2>AtomFeed/AddPageToFeed [ Subprograms ]</h2>
<a name="robo23"></a><h2>AtomFeed/AddPageToFeed [ Subprograms ]</h2>

<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="#robo0">AtomFeed</a> ] [ <a href="./robo_subprograms.html#robo_top_of_doc">Subprograms</a> ]</p>
<p class="item_name">FUNCTION</p>
<pre> Add page with full path FileName and it extracted Atom entries Entries to the site Atom feed
</pre>
<p class="item_name">SOURCE</p>
<pre class="source"> <span class="keyword">procedure</span> <strong>AddPageToFeed</strong>
<span class="sign">(</span>FileName<span class="sign">:</span> String<span class="sign">;</span> Entries<span class="sign">:</span> <span class="keyword">in</span> <span class="keyword">out</span> <a href="#robo10">FeedEntry_Container</a><span class="sign">.</span>Vector<span class="sign">)</span><span class="sign">;</span>
<span class="sign">(</span>FileName<span class="sign">:</span> String<span class="sign">;</span> Entries<span class="sign">:</span> <span class="keyword">in</span> <span class="keyword">out</span> <a href="#robo11">FeedEntry_Container</a><span class="sign">.</span>Vector<span class="sign">)</span><span class="sign">;</span>
</pre>
<p class="item_name">PARAMETERS</p>
<pre> FileName - File name of the page to add
Expand All @@ -111,7 +111,7 @@ <h3>TABLE OF CONTENTS</h3>

<hr />
<a name="AtomFeed2fSaveAtomFeed"></a>
<a name="robo22"></a><h2>AtomFeed/SaveAtomFeed [ Subprograms ]</h2>
<a name="robo24"></a><h2>AtomFeed/SaveAtomFeed [ Subprograms ]</h2>

<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="#robo0">AtomFeed</a> ] [ <a href="./robo_subprograms.html#robo_top_of_doc">Subprograms</a> ]</p>
<p class="item_name">FUNCTION</p>
Expand All @@ -123,7 +123,7 @@ <h3>TABLE OF CONTENTS</h3>

<hr />
<a name="AtomFeed2fStartAtomFeed"></a>
<a name="robo23"></a><h2>AtomFeed/StartAtomFeed [ Subprograms ]</h2>
<a name="robo25"></a><h2>AtomFeed/StartAtomFeed [ Subprograms ]</h2>

<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="#robo0">AtomFeed</a> ] [ <a href="./robo_subprograms.html#robo_top_of_doc">Subprograms</a> ]</p>
<p class="item_name">FUNCTION</p>
Expand All @@ -135,7 +135,7 @@ <h3>TABLE OF CONTENTS</h3>

<hr />
<a name="AtomFeed2fTo5fHTTP5fDate"></a>
<a name="robo24"></a><h2>AtomFeed/To_HTTP_Date [ Subprograms ]</h2>
<a name="robo26"></a><h2>AtomFeed/To_HTTP_Date [ Subprograms ]</h2>

<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="#robo0">AtomFeed</a> ] [ <a href="./robo_subprograms.html#robo_top_of_doc">Subprograms</a> ]</p>
<p class="item_name">FUNCTION</p>
Expand All @@ -153,7 +153,7 @@ <h3>TABLE OF CONTENTS</h3>

<hr />
<a name="AtomFeed2fTo5fTime"></a>
<a name="robo25"></a><h2>AtomFeed/To_Time [ Subprograms ]</h2>
<a name="robo27"></a><h2>AtomFeed/To_Time [ Subprograms ]</h2>

<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="#robo0">AtomFeed</a> ] [ <a href="./robo_subprograms.html#robo_top_of_doc">Subprograms</a> ]</p>
<p class="item_name">FUNCTION</p>
Expand All @@ -171,7 +171,7 @@ <h3>TABLE OF CONTENTS</h3>

</div> <!-- content -->
<div id="footer">
<p>Generated from ./src/atomfeed.ads with <a href="http://www.xs4all.nl/~rfsber/Robo/robodoc.html">ROBODoc</a> V4.99.43 on Tue Oct 22 2019 06:45:03
<p>Generated from ./src/atomfeed.ads with <a href="http://www.xs4all.nl/~rfsber/Robo/robodoc.html">ROBODoc</a> V4.99.43 on Sun Nov 17 2019 06:40:33
</p>
</div> <!-- footer -->
</body>
Expand Down
76 changes: 47 additions & 29 deletions docs/code/config_ads.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@
<link rel="stylesheet" href="./robodoc.css" type="text/css" />
<title>./src/config.ads</title>
<!-- Source: ./src/config.ads -->
<!-- Generated with ROBODoc Version 4.99.43 (Feb 2 2019) -->
<!-- Generated with ROBODoc Version 4.99.43 (Jul 26 2019) -->
</head>
<body>
<div id="logo">
<a name="robo_top_of_doc">YASS v1.1 code documentation</a>
<a name="robo_top_of_doc">YASS v2.0 code documentation</a>
</div> <!-- logo -->
<div id="navigation">
<a class="menuitem" href="./toc_index.html#top">Table of Contents</a>
Expand All @@ -30,17 +30,18 @@ <h3>TABLE OF CONTENTS</h3>
<ul>
<li>1. <a href="#robo1">Yass/Config</a></li>
<ul>
<li>1.1. <a href="#robo11">Config/Excluded_Container</a></li>
<li>1.2. <a href="#robo12">Config/ParserConfig</a></li>
<li>1.3. <a href="#robo13">Config/TableTags_Container</a></li>
<li>1.4. <a href="#robo14">Config/Tags_Container</a></li>
<li>1.5. <a href="#robo15">Config/GlobalTableTags</a></li>
<li>1.6. <a href="#robo16">Config/SiteDirectory</a></li>
<li>1.7. <a href="#robo17">Config/SiteTags</a></li>
<li>1.8. <a href="#robo18">Config/YassConfig</a></li>
<li>1.9. <a href="#robo19">Config/InvalidConfigData</a></li>
<li>1.10. <a href="#robo26">Config/CreateConfig</a></li>
<li>1.11. <a href="#robo27">Config/ParseConfig</a></li>
<li>1.1. <a href="#robo12">Config/Excluded_Container</a></li>
<li>1.2. <a href="#robo13">Config/ParserConfig</a></li>
<li>1.3. <a href="#robo14">Config/TableTags_Container</a></li>
<li>1.4. <a href="#robo15">Config/Tags_Container</a></li>
<li>1.5. <a href="#robo17">Config/GlobalTableTags</a></li>
<li>1.6. <a href="#robo18">Config/SiteDirectory</a></li>
<li>1.7. <a href="#robo19">Config/SiteTags</a></li>
<li>1.8. <a href="#robo20">Config/YassConfig</a></li>
<li>1.9. <a href="#robo21">Config/InvalidConfigData</a></li>
<li>1.10. <a href="#robo28">Config/CreateConfig</a></li>
<li>1.11. <a href="#robo29">Config/CreateInteractiveConfig</a></li>
<li>1.12. <a href="#robo30">Config/ParseConfig</a></li>
</ul>
</ul>
<hr />
Expand All @@ -57,7 +58,7 @@ <h3>TABLE OF CONTENTS</h3>

<hr />
<a name="Config2fExcluded5fContainer"></a>
<a name="robo11"></a><h2>Config/Excluded_Container [ Types ]</h2>
<a name="robo12"></a><h2>Config/Excluded_Container [ Types ]</h2>

<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="#robo1">Config</a> ] [ <a href="./robo_types.html#robo_top_of_doc">Types</a> ]</p>
<p class="item_name">FUNCTION</p>
Expand All @@ -70,7 +71,7 @@ <h3>TABLE OF CONTENTS</h3>

<hr />
<a name="Config2fParserConfig"></a>
<a name="robo12"></a><h2>Config/ParserConfig [ Types ]</h2>
<a name="robo13"></a><h2>Config/ParserConfig [ Types ]</h2>

<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="#robo1">Config</a> ] [ <a href="./robo_types.html#robo_top_of_doc">Types</a> ]</p>
<p class="item_name">FUNCTION</p>
Expand All @@ -81,7 +82,7 @@ <h3>TABLE OF CONTENTS</h3>
OutputDirectory<span class="sign">:</span> Unbounded_String <span class="sign">:</span><span class="sign">=</span> To_Unbounded_String<span class="sign">(</span><span class="quote">"_output"</span><span class="sign">)</span><span class="sign">;</span>
LayoutsDirectory<span class="sign">:</span> Unbounded_String <span class="sign">:</span><span class="sign">=</span> To_Unbounded_String<span class="sign">(</span><span class="quote">"_layouts"</span><span class="sign">)</span><span class="sign">;</span>
ModulesDirectory<span class="sign">:</span> Unbounded_String <span class="sign">:</span><span class="sign">=</span> To_Unbounded_String<span class="sign">(</span><span class="quote">"_modules"</span><span class="sign">)</span><span class="sign">;</span>
ExcludedFiles<span class="sign">:</span> <a href="#robo11">Excluded_Container</a><span class="sign">.</span>Vector<span class="sign">;</span>
ExcludedFiles<span class="sign">:</span> <a href="#robo12">Excluded_Container</a><span class="sign">.</span>Vector<span class="sign">;</span>
ServerEnabled<span class="sign">:</span> Boolean <span class="sign">:</span><span class="sign">=</span> True<span class="sign">;</span>
ServerPort<span class="sign">:</span> Positive <span class="sign">:</span><span class="sign">=</span> 8888<span class="sign">;</span>
MonitorInterval<span class="sign">:</span> Duration <span class="sign">:</span><span class="sign">=</span> 5<span class="sign">.</span>0<span class="sign">;</span>
Expand Down Expand Up @@ -138,7 +139,7 @@ <h3>TABLE OF CONTENTS</h3>

<hr />
<a name="Config2fTableTags5fContainer"></a>
<a name="robo13"></a><h2>Config/TableTags_Container [ Types ]</h2>
<a name="robo14"></a><h2>Config/TableTags_Container [ Types ]</h2>

<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="#robo1">Config</a> ] [ <a href="./robo_types.html#robo_top_of_doc">Types</a> ]</p>
<p class="item_name">FUNCTION</p>
Expand All @@ -151,7 +152,7 @@ <h3>TABLE OF CONTENTS</h3>

<hr />
<a name="Config2fTags5fContainer"></a>
<a name="robo14"></a><h2>Config/Tags_Container [ Types ]</h2>
<a name="robo15"></a><h2>Config/Tags_Container [ Types ]</h2>

<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="#robo1">Config</a> ] [ <a href="./robo_types.html#robo_top_of_doc">Types</a> ]</p>
<p class="item_name">FUNCTION</p>
Expand All @@ -164,19 +165,19 @@ <h3>TABLE OF CONTENTS</h3>

<hr />
<a name="Config2fGlobalTableTags"></a>
<a name="robo15"></a><h2>Config/GlobalTableTags [ Variables ]</h2>
<a name="robo17"></a><h2>Config/GlobalTableTags [ Variables ]</h2>

<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="#robo1">Config</a> ] [ <a href="./robo_variables.html#robo_top_of_doc">Variables</a> ]</p>
<p class="item_name">FUNCTION</p>
<pre> Global table tags, used in @@TABLE@@ statement
</pre>
<p class="item_name">SOURCE</p>
<pre class="source"> <strong>GlobalTableTags</strong><span class="sign">:</span> <a href="#robo13">TableTags_Container</a><span class="sign">.</span>Map<span class="sign">;</span>
<pre class="source"> <strong>GlobalTableTags</strong><span class="sign">:</span> <a href="#robo14">TableTags_Container</a><span class="sign">.</span>Map<span class="sign">;</span>
</pre>

<hr />
<a name="Config2fSiteDirectory"></a>
<a name="robo16"></a><h2>Config/SiteDirectory [ Variables ]</h2>
<a name="robo18"></a><h2>Config/SiteDirectory [ Variables ]</h2>

<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="#robo1">Config</a> ] [ <a href="./robo_variables.html#robo_top_of_doc">Variables</a> ]</p>
<p class="item_name">FUNCTION</p>
Expand All @@ -188,31 +189,31 @@ <h3>TABLE OF CONTENTS</h3>

<hr />
<a name="Config2fSiteTags"></a>
<a name="robo17"></a><h2>Config/SiteTags [ Variables ]</h2>
<a name="robo19"></a><h2>Config/SiteTags [ Variables ]</h2>

<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="#robo1">Config</a> ] [ <a href="./robo_variables.html#robo_top_of_doc">Variables</a> ]</p>
<p class="item_name">FUNCTION</p>
<pre> Site tags (like title, author, etc)
</pre>
<p class="item_name">SOURCE</p>
<pre class="source"> <strong>SiteTags</strong><span class="sign">:</span> <a href="#robo14">Tags_Container</a><span class="sign">.</span>Map<span class="sign">;</span>
<pre class="source"> <strong>SiteTags</strong><span class="sign">:</span> <a href="#robo15">Tags_Container</a><span class="sign">.</span>Map<span class="sign">;</span>
</pre>

<hr />
<a name="Config2fYassConfig"></a>
<a name="robo18"></a><h2>Config/YassConfig [ Variables ]</h2>
<a name="robo20"></a><h2>Config/YassConfig [ Variables ]</h2>

<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="#robo1">Config</a> ] [ <a href="./robo_variables.html#robo_top_of_doc">Variables</a> ]</p>
<p class="item_name">FUNCTION</p>
<pre> Settings for the program
</pre>
<p class="item_name">SOURCE</p>
<pre class="source"> <strong>YassConfig</strong><span class="sign">:</span> <a href="#robo12">ParserConfig</a><span class="sign">;</span>
<pre class="source"> <strong>YassConfig</strong><span class="sign">:</span> <a href="#robo13">ParserConfig</a><span class="sign">;</span>
</pre>

<hr />
<a name="Config2fInvalidConfigData"></a>
<a name="robo19"></a><h2>Config/InvalidConfigData [ Exceptions ]</h2>
<a name="robo21"></a><h2>Config/InvalidConfigData [ Exceptions ]</h2>

<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="#robo1">Config</a> ] [ <a href="./robo_exceptions.html#robo_top_of_doc">Exceptions</a> ]</p>
<p class="item_name">FUNCTION</p>
Expand All @@ -224,7 +225,7 @@ <h3>TABLE OF CONTENTS</h3>

<hr />
<a name="Config2fCreateConfig"></a>
<a name="robo26"></a><h2>Config/CreateConfig [ Subprograms ]</h2>
<a name="robo28"></a><h2>Config/CreateConfig [ Subprograms ]</h2>

<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="#robo1">Config</a> ] [ <a href="./robo_subprograms.html#robo_top_of_doc">Subprograms</a> ]</p>
<p class="item_name">FUNCTION</p>
Expand All @@ -238,9 +239,26 @@ <h3>TABLE OF CONTENTS</h3>
created
</pre>

<hr />
<a name="Config2fCreateInteractiveConfig"></a>
<a name="robo29"></a><h2>Config/CreateInteractiveConfig [ Subprograms ]</h2>

<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="#robo1">Config</a> ] [ <a href="./robo_subprograms.html#robo_top_of_doc">Subprograms</a> ]</p>
<p class="item_name">FUNCTION</p>
<pre> Create configuration file based on the user answers to the program
questions
</pre>
<p class="item_name">SOURCE</p>
<pre class="source"> <span class="keyword">procedure</span> <strong>CreateInteractiveConfig</strong><span class="sign">(</span>DirectoryName<span class="sign">:</span> String<span class="sign">)</span><span class="sign">;</span>
</pre>
<p class="item_name">PARAMETERS</p>
<pre> DirectoryName - Full path to the directory where config file will be
created
</pre>

<hr />
<a name="Config2fParseConfig"></a>
<a name="robo27"></a><h2>Config/ParseConfig [ Subprograms ]</h2>
<a name="robo30"></a><h2>Config/ParseConfig [ Subprograms ]</h2>

<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="#robo1">Config</a> ] [ <a href="./robo_subprograms.html#robo_top_of_doc">Subprograms</a> ]</p>
<p class="item_name">FUNCTION</p>
Expand All @@ -257,7 +275,7 @@ <h3>TABLE OF CONTENTS</h3>

</div> <!-- content -->
<div id="footer">
<p>Generated from ./src/config.ads with <a href="http://www.xs4all.nl/~rfsber/Robo/robodoc.html">ROBODoc</a> V4.99.43 on Tue Oct 22 2019 06:45:03
<p>Generated from ./src/config.ads with <a href="http://www.xs4all.nl/~rfsber/Robo/robodoc.html">ROBODoc</a> V4.99.43 on Sun Nov 17 2019 06:40:33
</p>
</div> <!-- footer -->
</body>
Expand Down
Loading

0 comments on commit 42ad1e4

Please sign in to comment.