summaryrefslogtreecommitdiffstats
path: root/src/qtattributionsscanner/scanner.h
diff options
context:
space:
mode:
authorKai Koehne <kai.koehne@qt.io>2016-04-27 12:40:10 +0200
committerKai Koehne <kai.koehne@qt.io>2016-08-05 12:10:46 +0000
commitacb38b386969a9e03faa117fabc6c82e59003de5 (patch)
tree90391efd659d202915a3db439cb399ac8d33af95 /src/qtattributionsscanner/scanner.h
parent517d8268eb3b96fa7e43ef406c9d1999614418c5 (diff)
Add qtattributionsscanner tool
qtattributionsscanner generates qdoc documentation about third party licenses in Qt sources. It scans recursively for qt_attribution.json files in the directory given on the command line. The qt_attribution.json file format is also documented under http://wiki.qt.io/Qt_attribution.json Task-number: QTBUG-55139 Change-Id: Ie8d9115beb9457c9f60a79e11c1c13dd19184d1c Reviewed-by: Topi Reiniƶ <topi.reinio@theqtcompany.com>
Diffstat (limited to 'src/qtattributionsscanner/scanner.h')
-rw-r--r--src/qtattributionsscanner/scanner.h45
1 files changed, 45 insertions, 0 deletions
diff --git a/src/qtattributionsscanner/scanner.h b/src/qtattributionsscanner/scanner.h
new file mode 100644
index 000000000..47d4aa6d9
--- /dev/null
+++ b/src/qtattributionsscanner/scanner.h
@@ -0,0 +1,45 @@
+/****************************************************************************
+**
+** Copyright (C) 2016 The Qt Company Ltd.
+** Contact: https://www.qt.io/licensing/
+**
+** This file is part of the tools applications of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:GPL-EXCEPT$
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and The Qt Company. For licensing terms
+** and conditions see https://www.qt.io/terms-conditions. For further
+** information use the contact form at https://www.qt.io/contact-us.
+**
+** GNU General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU
+** General Public License version 3 as published by the Free Software
+** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
+** included in the packaging of this file. Please review the following
+** information to ensure the GNU General Public License requirements will
+** be met: https://www.gnu.org/licenses/gpl-3.0.html.
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+#ifndef SCANNER_H
+#define SCANNER_H
+
+#include "logging.h"
+#include "package.h"
+
+#include <QtCore/qstring.h>
+#include <QtCore/qvector.h>
+
+namespace Scanner {
+
+QVector<Package> readDirectory(const QString &packageDirectory, LogLevel logLevel);
+QVector<Package> scanDirectory(const QString &directory, LogLevel logLevel);
+
+}
+
+#endif // SCANNER_H