NumeRe v1.1.4
NumeRe: Framework für Numerische Rechnungen
documentation.hpp
Go to the documentation of this file.
1/*****************************************************************************
2 NumeRe: Framework fuer Numerische Rechnungen
3 Copyright (C) 2014 Erik Haenel et al.
4
5 This program is free software: you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published by
7 the Free Software Foundation, either version 3 of the License, or
8 (at your option) any later version.
9
10 This program 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
13 GNU General Public License for more details.
14
15 You should have received a copy of the GNU General Public License
16 along with this program. If not, see <http://www.gnu.org/licenses/>.
17******************************************************************************/
18
19
20#ifndef DOCUMENTATION_HPP
21#define DOCUMENTATION_HPP
22
23#include <string>
24#include "../settings.hpp"
25
26extern const std::string sVersion;
27
28void doc_Help(const std::string&, Settings&);
29std::string doc_HelpAsHTML(const std::string&, bool, Settings& _option);
30void doc_SearchFct(const std::string& sToLookFor, Settings& _option);
31
32
33#endif
34
This class manages the setting values of the internal (kernel) settings of this application.
Definition: settings.hpp:663
std::string doc_HelpAsHTML(const std::string &, bool, Settings &_option)
This function returns the documentation article for the selected topic as an HTML std::string....
void doc_Help(const std::string &, Settings &)
This function shows the content of a documentation article based upon the passed topic....
void doc_SearchFct(const std::string &sToLookFor, Settings &_option)
This function provides the logic for searching for entries in the keywords database.
const std::string sVersion