KDocTools 5.109.0
|
Utility methods to generate documentation in various format from DocBook files. More...
Functions | |
QStringList | documentationDirs () |
Returns the directories which can contain documentation. | |
QByteArray | extractFileToBuffer (const QString &content, const QString &filename) |
Extract the content of a single file from the content string generated by the transformation scripts. | |
QString | locateFileInDtdResource (const QString &file, const QStandardPaths::LocateOptions option=QStandardPaths::LocateFile) |
Find a specified file amongst the resource shipped with KDocTools. | |
bool | saveToCache (const QString &contents, const QString &filename) |
Save the content (compressed) in the specified filename. | |
void | setupStandardDirs (const QString &srcdir=QString()) |
Initialize the XML catalog used by XSLT functions from the standard directories or from the specified srcdir. | |
QString | transform (const QString &file, const QString &stylesheet, const QVector< const char * > ¶ms=QVector< const char * >()) |
Transform and return the content of file with the specified XSLT stylesheet (both already in memory) using the optional parameters. | |
Utility methods to generate documentation in various format from DocBook files.
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 QVector< const char * > & | params = QVector< const char * >() |
||
) |
Transform and return the content of file with the specified XSLT stylesheet (both already in memory) using the optional parameters.