Added some doc.

This commit is contained in:
Patrick von Reth 2015-07-05 12:16:33 +02:00
parent ba8e6bde21
commit b08310d869

View File

@ -31,14 +31,55 @@ class SNORE_EXPORT Utils : public QObject
{ {
Q_OBJECT Q_OBJECT
public: public:
/**
* The MARKUP_FLAG enum.
* If a falg is not present the markup key will be removed.
* If any flag is present, special characters mus be html escaped.
*/
enum MARKUP_FLAG { enum MARKUP_FLAG {
/**
* No markup is supported.
* All markup will be removed.
*/
NO_MARKUP = 0, NO_MARKUP = 0,
/**
* Urls are supprotet.
* <a href="www.foo.bar">Foo Bar</a>
*/
HREF = 1 << 0, HREF = 1 << 0,
/**
* Line breeaks &lt;br&gt; are supprotet.
* If the flag is not present &lt;br&gt; will be replaced by \\n
*/
BREAK = 1 << 1, BREAK = 1 << 1,
/**
* Bold &lt;b&gt; is supportet.
*/
BOLD = 1 << 2, BOLD = 1 << 2,
/**
* Italic &lt;i&gt; is supportet.
*/
ITALIC = 1 << 3, ITALIC = 1 << 3,
/**
* Underline &lt;u&gt; is supportet.
*/
UNDERLINE = 1 << 4, UNDERLINE = 1 << 4,
/**
* Fonst are supportet.
* &lt;font color="blue"&gt; word &lt;/font&gt;
*/
FONT = 1 << 5, FONT = 1 << 5,
/**
* All markup is supported.
* No markup will be removed.
*/
ALL_MARKUP = ~0 ALL_MARKUP = ~0
}; };