Relintai/pandemonium_engine
1
0
Fork 0
mirror of https://github.com/Relintai/pandemonium_engine.git synced 2024-12-23 12:26:59 +01:00
Code Issues Packages Projects Releases Wiki Activity

Added docs for PagedArticlesWebPage.

Browse Source
This commit is contained in:
Relintai 2022-08-21 22:53:50 +02:00
parent 8cd72fc8d8
commit 25230bee02
1 changed files with 4 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
modules/web/doc_classes/PagedArticlesWebPage.xml
View File

@ -1,8 +1,11 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="PagedArticlesWebPage" inherits="WebNode" version="3.7"> <class name="PagedArticlesWebPage" inherits="WebNode" version="3.7">
<brief_description> <brief_description>
The [PagedArticlesWebPage] class creates [PagedArticleWebPage] for all folders found inside [code]folder[/code].
</brief_description> </brief_description>
<description> <description>
The [PagedArticlesWebPage] class enumarates all folders found inside the folder set to it's [code]folder[/code] property, and then creates and sets up [PagedArticleWebPage] classes for each one, and add them as it's children.
It will also generate an index page from the available articles.
</description> </description>
<tutorials> <tutorials>
</tutorials> </tutorials>
@ -10,6 +13,7 @@
</methods> </methods>
<members> <members>
<member name="folder" type="String" setter="set_folder" getter="get_folder" default="&quot;&quot;"> <member name="folder" type="String" setter="set_folder" getter="get_folder" default="&quot;&quot;">
The folder to evaluate.
</member> </member>
</members> </members>
<constants> <constants>