updated documentation

This commit is contained in:
Booklordofthedings 2024-09-30 14:46:03 +02:00
parent 7c360a1dd8
commit 9d80e70c76
3 changed files with 17 additions and 6 deletions

View file

@ -1,7 +1,14 @@
# Classes
- Crawler
- DataStore
- [Crawler](#Crawler)
- [DataStore](#DataStore)
- [SectionFinder](#SectionFinder)
## Crawler
Crawls through the input directory in order to read all input files and get all available sections.## DataStore
Crawls through the input directory in order to read all input files and get all available sections.
## DataStore
Store information about the entire setup of the program,
while its running, so that it can be recovered later
while its running, so that it can be recovered later
## SectionFinder
Used to comb through the file to find all sections that are marked by bdocs

View file

@ -23,11 +23,11 @@ class DataStore
{
pBuffer.Append("# Classes\n");
for(var i in Classes)
pBuffer.Append(scope $"- {i.key}\n");
pBuffer.Append(scope $"- [{i.key}](#{i.key})\n");
for(var i in Classes)
{
pBuffer.Append(scope $"## {i.key}\n{i.value.Description}");
pBuffer.Append(scope $"## {i.key}\n{i.value.Description}\n\n");
}
}

View file

@ -4,6 +4,10 @@ using System;
using System.IO;
using System.Collections;
/*$$$c
l n SectionFinder
t d Used to comb through the file to find all sections that are marked by bdocs
$$$*/
class SectionFinder
{
public static void GetSections(StringView pPath, List<String> pSections)