LibrePCB Developers Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
markdownconverter.h
Go to the documentation of this file.
1 /*
2  * LibrePCB - Professional EDA for everyone!
3  * Copyright (C) 2013 LibrePCB Developers, see AUTHORS.md for contributors.
4  * https://librepcb.org/
5  *
6  * This program is free software: you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation, either version 3 of the License, or
9  * (at your option) any later version.
10  *
11  * This program 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
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program. If not, see <http://www.gnu.org/licenses/>.
18  */
19 #ifndef LIBREPCB_MARKDOWNCONVERTER_H
20 #define LIBREPCB_MARKDOWNCONVERTER_H
21 
22 /*******************************************************************************
23  * Includes
24  ******************************************************************************/
26 
27 #include <QtCore>
28 
29 /*******************************************************************************
30  * Namespace / Forward Declarations
31  ******************************************************************************/
32 namespace librepcb {
33 namespace application {
34 
35 /*******************************************************************************
36  * Class MarkdownConverter
37  ******************************************************************************/
38 
42 class MarkdownConverter final {
43 public:
44  // Static Methods
45  static QString convertMarkdownToHtml(const FilePath& markdownFile) noexcept;
46  static QString convertMarkdownToHtml(const QString& markdown) noexcept;
47 
48 private:
49  // Constructors / Destructor
50  MarkdownConverter() = delete;
51  MarkdownConverter(const MarkdownConverter& other) = delete;
52  ~MarkdownConverter() = delete;
53 };
54 
55 /*******************************************************************************
56  * End of File
57  ******************************************************************************/
58 
59 } // namespace application
60 } // namespace librepcb
61 
62 #endif // LIBREPCB_MARKDOWNCONVERTER_H
The MarkdownConverter class.
Definition: markdownconverter.h:42
static QString convertMarkdownToHtml(const FilePath &markdownFile) noexcept
Definition: markdownconverter.cpp:41
This class represents absolute, well-formatted paths to files or directories.
Definition: filepath.h:130