mirror of https://github.com/KLayout/klayout.git
55 lines
1.3 KiB
C++
55 lines
1.3 KiB
C++
|
|
/*
|
|
|
|
KLayout Layout Viewer
|
|
Copyright (C) 2006-2017 Matthias Koefferlein
|
|
|
|
This program is free software; you can redistribute it and/or modify
|
|
it under the terms of the GNU General Public License as published by
|
|
the Free Software Foundation; either version 2 of the License, or
|
|
(at your option) any later version.
|
|
|
|
This program is distributed in the hope that it will be useful,
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
GNU General Public License for more details.
|
|
|
|
You should have received a copy of the GNU General Public License
|
|
along with this program; if not, write to the Free Software
|
|
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
|
|
|
|
*/
|
|
|
|
|
|
#ifndef HDR_layGSIHelpProvider
|
|
#define HDR_layGSIHelpProvider
|
|
|
|
#include "layHelpProvider.h"
|
|
|
|
#include <vector>
|
|
|
|
namespace lay
|
|
{
|
|
|
|
/**
|
|
* @brief Implements a help provider for the generated documentation
|
|
*/
|
|
class GSIHelpProvider
|
|
: public HelpProvider
|
|
{
|
|
public:
|
|
virtual std::string folder () const;
|
|
virtual std::string title () const;
|
|
virtual void toc (std::vector<std::string> &t);
|
|
virtual QDomDocument get (const std::string &u) const;
|
|
|
|
private:
|
|
std::string produce_class_doc (const std::string &cls) const;
|
|
std::string produce_class_index () const;
|
|
};
|
|
|
|
}
|
|
|
|
#endif
|
|
|