Add example to unescape_html() documentation.

2020-01-16 18:06:14 +01:00 · 2020-01-16 18:06:14 +01:00 · 8cfba1f16b
commit 8cfba1f16b
parent cf2ff119b4
1 changed files with 6 additions and 0 deletions
--- a/include/helpers.hpp
+++ b/include/helpers.hpp
@ -30,6 +30,12 @@ using std::string;
 *
 *  Supports named and numbered entities, decimal and hexadecimal.
 *
+ *  Example:
+ *  @code
+ *  // Will output: 2€ = 2€ = 2€
+ *  std::cout << mastodonpp::unescape_html("2&euro; = 2&#8364; = 2&#x20ac;");
+ *  @endcode
+ *
 *  @param  html The HTML to unescape.
 *
 *  @since  0.4.0