docdoxygenplugin.h
Go to the documentation of this file.00001
00002
00003
00004
00005
00006
00007
00008
00009
00010
00011
00012
00013
00014
00015
00016
00017
00018
00019
00020 #ifndef DOCDOXYGENPLUGIN_H
00021 #define DOCDOXYGENPLUGIN_H
00022
00023 #include <kdevdocumentationplugin.h>
00024
00025 class QDomDocument;
00026 class QDomElement;
00027
00028 class DocDoxygenPlugin: public DocumentationPlugin
00029 {
00030 Q_OBJECT
00031 public:
00032 DocDoxygenPlugin(QObject* parent, const char* name, const QStringList args = QStringList());
00033 ~DocDoxygenPlugin();
00034
00035 virtual QString pluginName() const;
00036
00037 virtual DocumentationCatalogItem *createCatalog(KListView *contents, const QString &title, const QString &url);
00038
00039 virtual void createTOC(DocumentationCatalogItem* item);
00040 virtual void setCatalogURL(DocumentationCatalogItem* item);
00041
00042 virtual bool needRefreshIndex(DocumentationCatalogItem* item);
00043 virtual void createIndex(IndexBox* index, DocumentationCatalogItem* item);
00044
00045 virtual QStringList fullTextSearchLocations();
00046
00047 virtual QPair<KFile::Mode, QString> catalogLocatorProps();
00048 virtual QString catalogTitle(const QString& url);
00049
00050 virtual void autoSetupPlugin();
00051
00052 virtual ProjectDocumentationPlugin *projectDocumentationPlugin(ProjectDocType type);
00053
00054 protected:
00055 void createBookTOC(DocumentationItem* item, const QString &tagUrl = QString::null,
00056 const QString &baseHtmlUrl = QString::null);
00057 void createBookIndex(const QString &tagfile, IndexBox* index, DocumentationCatalogItem* item, const QString &baseHtmlUrl = QString::null);
00058
00059 void createIndexFromTag(QDomDocument &dom, IndexBox* index, DocumentationCatalogItem* item,
00060 QDomElement &parentEl, const QString &prefix);
00061 };
00062
00063
00064 #endif
This file is part of the documentation for KDevelop Version 3.1.2.