KDocTools Namespace
Utility methods to generate documentation in various format from DocBook files. More...
Header: | #include <docbookxslt.h> |
CMake: | find_package(KF6 REQUIRED COMPONENTS DocTools) target_link_libraries(mytarget PRIVATE KF6::DocTools) |
Functions
QStringList | documentationDirs() |
QByteArray | extractFileToBuffer(const QString &content, const QString &filename) |
QString | locateFileInDtdResource(const QString &file, const QStandardPaths::LocateOptions option = QStandardPaths::LocateFile) |
bool | saveToCache(const QString &contents, const QString &filename) |
void | setupStandardDirs(const QString &srcdir = QString()) |
QString | transform(const QString &file, const QString &stylesheet, const QList<const char *> ¶ms = QList<const char *>()) |
Detailed Description
Function Documentation
QStringList KDocTools::documentationDirs()
Returns the directories which can contain documentation.
QByteArray KDocTools::extractFileToBuffer(const QString &content, const QString &filename)
Extract the content of a single file from the content string generated by the transformation scripts.
QString KDocTools::locateFileInDtdResource(const QString &file, const QStandardPaths::LocateOptions option = QStandardPaths::LocateFile)
Find a specified file amongst the resource shipped with KDocTools.
bool KDocTools::saveToCache(const QString &contents, const QString &filename)
Save the content (compressed) in the specified filename.
void KDocTools::setupStandardDirs(const QString &srcdir = QString())
Initialize the XML catalog used by XSLT functions from the standard directories or from the specified srcdir.
QString KDocTools::transform(const QString &file, const QString &stylesheet, const QList<const char *> ¶ms = QList<const char *>())
Transform and return the content of file with the specified XSLT stylesheet (both already in memory) using the optional parameters.