author | Michael Krelin <hacker@klever.net> | 2007-03-04 00:28:39 (UTC) |
---|---|---|
committer | Michael Krelin <hacker@klever.net> | 2007-03-04 00:28:39 (UTC) |
commit | a3f38aafb288db5791b8dea34154cacc3c039971 (patch) (unidiff) | |
tree | b7f735ef9fde95de5935c1784d8d9486a3e4cf10 /include/sitecing/util.h | |
parent | ca2207bcf18ed5b0dd1a0e370e9973d717ff87c9 (diff) | |
download | sitecing-a3f38aafb288db5791b8dea34154cacc3c039971.zip sitecing-a3f38aafb288db5791b8dea34154cacc3c039971.tar.gz sitecing-a3f38aafb288db5791b8dea34154cacc3c039971.tar.bz2 |
some doxygen improvements
-rw-r--r-- | include/sitecing/util.h | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/include/sitecing/util.h b/include/sitecing/util.h index 5750ab6..a38ae90 100644 --- a/include/sitecing/util.h +++ b/include/sitecing/util.h | |||
@@ -13,33 +13,33 @@ | |||
13 | namespace sitecing { | 13 | namespace sitecing { |
14 | using namespace std; | 14 | using namespace std; |
15 | 15 | ||
16 | /** | 16 | /** |
17 | * the html_escape options enumeration. | 17 | * the html_escape options enumeration. |
18 | */ | 18 | */ |
19 | enum html_escape_options { | 19 | enum html_escape_options { |
20 | /** | 20 | /** |
21 | * Turn spaces into | 21 | * Turn spaces into |
22 | */ | 22 | */ |
23 | html_escape_nbsp = 0x0001, | 23 | html_escape_nbsp = 0x0001, |
24 | /** | 24 | /** |
25 | * Turn newlines into <br/> or <br>. | 25 | * Turn newlines into br/ or br. |
26 | */ | 26 | */ |
27 | html_escape_br = 0x0002, | 27 | html_escape_br = 0x0002, |
28 | /** | 28 | /** |
29 | * Turn quotes to " | 29 | * Turn quotes to " |
30 | */ | 30 | */ |
31 | html_escape_quot = 0x0004, | 31 | html_escape_quot = 0x0004, |
32 | /** | 32 | /** |
33 | * Do not put '/' into <br/> consruct. | 33 | * Do not put '/' into br consruct. |
34 | */ | 34 | */ |
35 | html_escape_br_noslash = 0x0008 | 35 | html_escape_br_noslash = 0x0008 |
36 | }; | 36 | }; |
37 | /** | 37 | /** |
38 | * Escape string suitable for html output. | 38 | * Escape string suitable for html output. |
39 | * @param str the string. | 39 | * @param str the string. |
40 | * @param flags options. | 40 | * @param flags options. |
41 | * @return the string escaped. | 41 | * @return the string escaped. |
42 | * @see html_escape_options | 42 | * @see html_escape_options |
43 | */ | 43 | */ |
44 | string html_escape(const string& str,int flags=html_escape_br); | 44 | string html_escape(const string& str,int flags=html_escape_br); |
45 | 45 | ||