From 9d80e70c768a89f7a91774274e1ab24cea8a53bf Mon Sep 17 00:00:00 2001 From: Booklordofthedings Date: Mon, 30 Sep 2024 14:46:03 +0200 Subject: [PATCH] updated documentation --- documentation.md | 15 +++++++++++---- src/DataStore.bf | 4 ++-- src/SectionFinder.bf | 4 ++++ 3 files changed, 17 insertions(+), 6 deletions(-) diff --git a/documentation.md b/documentation.md index dcfe6a2..a9a858a 100644 --- a/documentation.md +++ b/documentation.md @@ -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 \ No newline at end of file +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 + diff --git a/src/DataStore.bf b/src/DataStore.bf index cbb2f6b..868edcc 100644 --- a/src/DataStore.bf +++ b/src/DataStore.bf @@ -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"); } } diff --git a/src/SectionFinder.bf b/src/SectionFinder.bf index bfe7ac1..5f408c8 100644 --- a/src/SectionFinder.bf +++ b/src/SectionFinder.bf @@ -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 pSections)