From 71f8a129974b72034d5c9f2ede8c1ca5aa35b9f5 Mon Sep 17 00:00:00 2001
From: Relintai <relintai@protonmail.com>
Date: Tue, 15 Feb 2022 00:00:50 +0100
Subject: [PATCH] Added more docs.

---
 web_modules/paged_article/paged_article.h  |  7 +++++++
 web_modules/paged_article/paged_articles.h | 15 ++++++++++++++-
 2 files changed, 21 insertions(+), 1 deletion(-)

diff --git a/web_modules/paged_article/paged_article.h b/web_modules/paged_article/paged_article.h
index cc35eef..c9b5358 100644
--- a/web_modules/paged_article/paged_article.h
+++ b/web_modules/paged_article/paged_article.h
@@ -10,6 +10,13 @@
 
 #include "web/http/request.h"
 
+// This class will load and process all md files from the folder set to it's articles_folder property,
+// and serve every file from the directory set to it's serve_folder property.
+// if it finds a summary.md, it will serve it as the root.
+// It uses pagination.
+// THe links is generates currently look like: <url>/01_test.md
+// files are served under <url>/files/<file>
+
 class PagedArticle : public WebNode {
 	RCPP_OBJECT(PagedArticle, WebNode);
 
diff --git a/web_modules/paged_article/paged_articles.h b/web_modules/paged_article/paged_articles.h
index 963688f..32d41c8 100644
--- a/web_modules/paged_article/paged_articles.h
+++ b/web_modules/paged_article/paged_articles.h
@@ -9,7 +9,20 @@
 
 #include "web/http/request.h"
 
-// todo pagination
+// This class will load and process all md files from the folder set to it's folder property,
+// and generate one page from them. TThe files are processed in alphabetical order.
+
+// The generated HTML looks like:
+
+// render_menu()
+// <div class="article_list_entry">
+//	Contents of the first md file.
+// </div>
+// <div class="article_list_entry">
+//	Contents of the second md file.
+// </div>
+// ...
+// </div>
 
 class PagedArticles : public WebNode {
 	RCPP_OBJECT(PagedArticles, WebNode);