simgear/misc/SimpleMarkdown.hxx

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