pandemonium_engine/modules/web/doc_classes/BBCodeParser.xml

39 lines
1.3 KiB
XML
Raw Normal View History

2022-08-21 00:40:49 +02:00
<?xml version="1.0" encoding="UTF-8" ?>
2023-10-12 01:59:32 +02:00
<class name="BBCodeParser" inherits="Reference" version="4.2">
2022-08-21 00:40:49 +02:00
<brief_description>
A class that parses bbcode into a class structure for easy manipulation, or processing.
2022-08-21 00:40:49 +02:00
</brief_description>
<description>
The BBCodeParser class works the same way as the HTMLParser class, except it parses BBCode, which is a bit simpler, so some complexity was removed.
BBCode was created for providing a safer and simpler format for formatting post on forums. It is very similar to html.
For example: [code][b]This text should would be bold if this bbcode was interpreted.[/b] [size=14]This text would have a font size of 14.[/size] etc.[/code]
2022-08-21 00:40:49 +02:00
</description>
<tutorials>
</tutorials>
<methods>
<method name="convert_to_string" qualifiers="const">
<return type="String" />
<description>
</description>
</method>
<method name="get_root">
<return type="BBCodeParserTag" />
<description>
</description>
</method>
<method name="parse">
<return type="void" />
<argument index="0" name="data" type="String" />
<description>
</description>
</method>
<method name="print" qualifiers="const">
<return type="void" />
<description>
</description>
</method>
</methods>
<constants>
</constants>
</class>