simgear/misc/SimpleMarkdown.hxx

   1 ///@file
   2 /// Really simple markdown parser.
   3 //
   4 // Copyright (C) 2014  Thomas Geymayer <tomgey@gmail.com>
   5 //
   6 // This library is free software; you can redistribute it and/or
   7 // modify it under the terms of the GNU Library General Public
   8 // License as published by the Free Software Foundation; either
   9 // version 2 of the License, or (at your option) any later version.
  10 //
  11 // This library is distributed in the hope that it will be useful,
  12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 // Library General Public License for more details.
  15 //
  16 // You should have received a copy of the GNU Library General Public
  17 // License along with this library; if not, write to the Free Software
  18 // Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301, USA
  19
  20 #ifndef SIMPLE_MARKDOWN_HXX_
  21 #define SIMPLE_MARKDOWN_HXX_
  22
  23 #include <string>
  24
  25 namespace simgear
  26 {
  27   /**
  28    * Really simple mardown parser. Currently just paragraphs, new lines and
  29    * one level of unordered lists are supported.
  30    *
  31    * @see http://en.wikipedia.org/wiki/Markdown
  32    */
  33   class SimpleMarkdown
  34   {
  35     public:
  36       static std::string parse(const std::string& src);
  37   };
  38 } // namespace simgear
  39
  40 #endif /* SIMPLE_MARKDOWN_HXX_ */