/usr/include/apiextractor/docparser.h is in libapiextractor-dev 0.10.10-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 | /*
* This file is part of the API Extractor project.
*
* Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
*
* Contact: PySide team <contact@pyside.org>
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* version 2 as published by the Free Software Foundation.
*
* 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 DOCPARSER_H
#define DOCPARSER_H
#include <QString>
#include <QDir>
#include "abstractmetalang.h"
class QDomDocument;
class QDomNode;
class QXmlQuery;
class APIEXTRACTOR_API DocParser
{
public:
DocParser();
virtual ~DocParser();
virtual void fillDocumentation(AbstractMetaClass* metaClass) = 0;
/**
* Process and retrieves documentation concerning the entire
* module or library.
* \return object containing module/library documentation information
*/
virtual Documentation retrieveModuleDocumentation() = 0;
void setDocumentationDataDirectory(const QString& dir)
{
m_docDataDir = dir;
}
/**
* Informs the location of the XML data generated by the tool
* (e.g.: DoxyGen, qdoc) used to extract the library's documentation
* comment.
* \return the path for the directory containing the XML data created
* from the library's documentation beign parsed.
*/
QString documentationDataDirectory() const
{
return m_docDataDir;
}
void setLibrarySourceDirectory(const QString& dir)
{
m_libSourceDir = dir;
}
/**
* Informs the location of the library being parsed. The library
* source code is parsed for the documentation comments.
* \return the path for the directory containing the source code of
* the library beign parsed.
*/
QString librarySourceDirectory() const
{
return m_libSourceDir;
}
void setPackageName(const QString& packageName)
{
m_packageName = packageName;
}
/**
* Retrieves the name of the package (or module or library) being parsed.
* \return the name of the package (module/library) being parsed
*/
QString packageName() const
{
return m_packageName;
}
/**
* Process and retrieves documentation concerning the entire
* module or library.
* \param name module name
* \return object containing module/library documentation information
* \todo Merge with retrieveModuleDocumentation() on next ABI change.
*/
virtual Documentation retrieveModuleDocumentation(const QString& name) = 0;
protected:
QString getDocumentation(QXmlQuery& xquery, const QString& query,
const DocModificationList& mods) const;
private:
QString m_packageName;
QString m_docDataDir;
QString m_libSourceDir;
QString execXQuery(QXmlQuery& xquery, const QString& query) const;
QString applyDocModifications(const DocModificationList& mods, const QString& xml) const;
};
#endif // DOCPARSER_H
|