From 350f284bc6842e27ccf26f292e21b5f22a8ef0d7 Mon Sep 17 00:00:00 2001 From: Jerome Pasion Date: Thu, 3 Mar 2011 15:45:02 +0100 Subject: Added Qt Quick License information. Task-number: QTBUG-17879 Reviewed-by: David Boddie --- doc/src/declarative/declarativeui.qdoc | 9 ++++++-- doc/src/declarative/qtquick-intro.qdoc | 5 +++++ doc/src/legal/qtquicklicense.qdoc | 40 ++++++++++++++++++++++++++++++++++ 3 files changed, 52 insertions(+), 2 deletions(-) create mode 100644 doc/src/legal/qtquicklicense.qdoc diff --git a/doc/src/declarative/declarativeui.qdoc b/doc/src/declarative/declarativeui.qdoc index ff38ac6..8d8e6c6 100644 --- a/doc/src/declarative/declarativeui.qdoc +++ b/doc/src/declarative/declarativeui.qdoc @@ -90,7 +90,7 @@ Qt applications. \list \o \l{Debugging QML} -\o \l{Developing Qt Quick Applications with Creator}{Developing with Qt Creator} +\o \l{external: Developing Qt Quick Applications with Creator}{Developing with Qt Creator} \o \l{QML Viewer} \endlist @@ -102,7 +102,7 @@ Qt applications. \o \l{Qt Declarative Module} \o \l{QML Basic Types}{QML Data Types} \o \l{QML Coding Conventions} -\o \l{Qt Creator Manual} +\o \l{external: Qt Creator Manual}{Qt Creator Manual} \o \l{Programming with Qt} \o \l{http://doc.qt.nokia.com/qtmobility-1.1.0/index.html}{Qt Mobility Documentation} \endlist @@ -140,4 +140,9 @@ examples for porting} \o \l{QML Best Practices: Coding Conventions}{Coding Tips} \o \l{QML Performance}{Performance Tips} \endlist + +\section1 License Information +\list +\o \l{Qt Quick Licensing Information} +\endlist */ diff --git a/doc/src/declarative/qtquick-intro.qdoc b/doc/src/declarative/qtquick-intro.qdoc index 02b2c44..75236e6 100644 --- a/doc/src/declarative/qtquick-intro.qdoc +++ b/doc/src/declarative/qtquick-intro.qdoc @@ -113,6 +113,11 @@ The \l {Qt Quick} page has links to various Qt Quick topics such as QML features, addons, and tools. The \l {QML Examples and Demos} page has a gallery of QML applications. + +\section1 License Information +\list +\o \l{Qt Quick Licensing Information} +\endlist */ diff --git a/doc/src/legal/qtquicklicense.qdoc b/doc/src/legal/qtquicklicense.qdoc new file mode 100644 index 0000000..aa9e201 --- /dev/null +++ b/doc/src/legal/qtquicklicense.qdoc @@ -0,0 +1,40 @@ +/**************************************************************************** +** +** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies). +** All rights reserved. +** Contact: Nokia Corporation (qt-info@nokia.com) +** +** This file is part of the documentation of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:FDL$ +** No Commercial Usage +** This file contains pre-release code and may not be distributed. +** You may use this file in accordance with the terms and conditions +** contained in the Technology Preview License Agreement accompanying +** this package. +** +** GNU Free Documentation License +** Alternatively, this file may be used under the terms of the GNU Free +** Documentation License version 1.3 as published by the Free Software +** Foundation and appearing in the file included in the packaging of this +** file. +** +** If you have questions regarding the use of this file, please contact +** Nokia at qt-info@nokia.com. +** $QT_END_LICENSE$ +** +****************************************************************************/ + +/*! + \page qtquicklicense.html + \title Qt Quick Licensing Information + \ingroup licensing + \brief Qt Quick and QtDeclarative Licensing Information. + + +Applications created using Qt Quick are subject to the terms and conditions of the GNU Lesser General Public License as Qt Quick includes dependencies to QtScript and JavaScriptCore which are licensed under the terms of the GNU Library General Public License ("LGPL"). Qt Commercial Edition licensees that wish to distribute applications that use the Qt Quick need to be aware of their obligations under the LGPL. Individual contributor names and copyright dates can be found inline in the code. This library is free software; you can redistribute it and/or modify it under the terms of the GNU Library General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. This library 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 Library General Public License for more details. You should have received a copy of the GNU Library General Public License along with this library; see the file COPYING.LIB. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + +On the Qt web site, you can find a +\l{Qt Licensing Overview} and information on \l{Qt License Pricing} +for commercial editions of Qt and other Qt-related products. +*/ -- cgit v0.12 From 94d15eaa3beb436b071903ddaa70c384aed988da Mon Sep 17 00:00:00 2001 From: Martin Smith Date: Fri, 4 Mar 2011 13:25:20 +0100 Subject: qdoc: Added enum values and tag names for and These contain many subelements, whose tages were also added. --- tools/qdoc3/ditaxmlgenerator.cpp | 58 ++++++++++++++++++++++++++++++++++++---- tools/qdoc3/ditaxmlgenerator.h | 29 +++++++++++++++++++- 2 files changed, 81 insertions(+), 6 deletions(-) diff --git a/tools/qdoc3/ditaxmlgenerator.cpp b/tools/qdoc3/ditaxmlgenerator.cpp index 6f7de73..ced14cc 100644 --- a/tools/qdoc3/ditaxmlgenerator.cpp +++ b/tools/qdoc3/ditaxmlgenerator.cpp @@ -96,11 +96,21 @@ QString DitaXmlGenerator::ditaTags[] = "apiDesc", "APIMap", "apiName", + "audience", + "author", "b", "body", "bodydiv", + "brand", + "category", "codeblock", "comment", + "component", + "copyrholder", + "copyright", + "copyryear", + "created", + "critdates", "cxxAPIMap", "cxxClass", "cxxClassAbstract", @@ -194,6 +204,8 @@ QString DitaXmlGenerator::ditaTags[] = "cxxVariableReimplemented", "cxxVariableScopedName", "cxxVariableStorageClassSpecifierStatic", + "data", + "data-about", "dd", "dl", "dlentry", @@ -203,21 +215,33 @@ QString DitaXmlGenerator::ditaTags[] = "i", "image", "keyword", + "keywords", "li", "link", "linktext", "lq", + "metadata", "ol", + "othermeta", "p", "parameter", + "permissions", "ph", + "platform", "pre", + "prodinfo", + "prodname", + "prolog", + "publisher", "related-links", + "resourceid", + "revised", "row", "section", "sectiondiv", "shortdesc", "simpletable", + "source", "stentry", "sthead", "strow", @@ -233,8 +257,11 @@ QString DitaXmlGenerator::ditaTags[] = "topicmeta", "topicref", "tt", - "ul", "u", + "ul", + "unknown", + "vrm", + "vrmlist", "xref", "" }; @@ -1611,8 +1638,11 @@ DitaXmlGenerator::generateClassLikeNode(const InnerNode* inner, CodeMarker* mark generateHeader(inner, fullTitle); generateBrief(inner, marker); // - // not included: - + writeStartTag(DT_prolog); + writeStartTag(DT_metadata); + writeEndTag(); // + writeEndTag(); // + writeStartTag(DT_cxxClassDetail); writeStartTag(DT_cxxClassDefinition); writeLocation(nsn); @@ -1735,7 +1765,10 @@ DitaXmlGenerator::generateClassLikeNode(const InnerNode* inner, CodeMarker* mark generateHeader(inner, fullTitle); generateBrief(inner, marker); // - // not included: + writeStartTag(DT_prolog); + writeStartTag(DT_metadata); + writeEndTag(); // + writeEndTag(); // writeStartTag(DT_cxxClassDetail); writeStartTag(DT_cxxClassDefinition); @@ -1876,6 +1909,12 @@ DitaXmlGenerator::generateClassLikeNode(const InnerNode* inner, CodeMarker* mark */ generateHeader(inner, fullTitle); generateBrief(inner, marker); // + + writeStartTag(DT_prolog); + writeStartTag(DT_metadata); + writeEndTag(); // + writeEndTag(); // + writeStartTag(DT_cxxClassDetail); writeStartTag(DT_apiDesc); xmlWriter().writeAttribute("spectitle",title); @@ -1996,7 +2035,10 @@ DitaXmlGenerator::generateClassLikeNode(const InnerNode* inner, CodeMarker* mark generateHeader(inner, fullTitle); generateBrief(inner, marker); // - // not included: + writeStartTag(DT_prolog); + writeStartTag(DT_metadata); + writeEndTag(); // + writeEndTag(); // writeStartTag(DT_cxxClassDetail); writeStartTag(DT_apiDesc); @@ -2106,6 +2148,12 @@ void DitaXmlGenerator::generateFakeNode(const FakeNode* fake, CodeMarker* marker generateHeader(fake, fullTitle); generateBrief(fake, marker); // + + writeStartTag(DT_prolog); + writeStartTag(DT_metadata); + writeEndTag(); // + writeEndTag(); // + writeStartTag(DT_body); if (fake->subType() == Node::Module) { generateStatus(fake, marker); diff --git a/tools/qdoc3/ditaxmlgenerator.h b/tools/qdoc3/ditaxmlgenerator.h index fb09013..2384a90 100644 --- a/tools/qdoc3/ditaxmlgenerator.h +++ b/tools/qdoc3/ditaxmlgenerator.h @@ -87,11 +87,21 @@ class DitaXmlGenerator : public PageGenerator DT_apiDesc, DT_APIMap, DT_apiName, + DT_audience, + DT_author, DT_b, DT_body, DT_bodydiv, + DT_brand, + DT_category, DT_codeblock, DT_comment, + DT_component, + DT_copyrholder, + DT_copyright, + DT_copyryear, + DT_created, + DT_critdates, DT_cxxAPIMap, DT_cxxClass, DT_cxxClassAbstract, @@ -185,6 +195,8 @@ class DitaXmlGenerator : public PageGenerator DT_cxxVariableReimplemented, DT_cxxVariableScopedName, DT_cxxVariableStorageClassSpecifierStatic, + DT_data, + DT_dataabout, DT_dd, DT_dl, DT_dlentry, @@ -194,21 +206,33 @@ class DitaXmlGenerator : public PageGenerator DT_i, DT_image, DT_keyword, + DT_keywords, DT_li, DT_link, DT_linktext, DT_lq, + DT_metadata, DT_ol, + DT_othermeta, DT_p, DT_parameter, + DT_permissions, DT_ph, + DT_platform, DT_pre, + DT_prodinfo, + DT_prodname, + DT_prolog, + DT_publisher, DT_relatedLinks, + DT_resourceid, + DT_revised, DT_row, DT_section, DT_sectiondiv, DT_shortdesc, DT_simpletable, + DT_source, DT_stentry, DT_sthead, DT_strow, @@ -224,8 +248,11 @@ class DitaXmlGenerator : public PageGenerator DT_topicmeta, DT_topicref, DT_tt, - DT_ul, DT_u, + DT_ul, + DT_unknown, + DT_vrm, + DT_vrmlist, DT_xref, DT_LAST }; -- cgit v0.12 From c7871bcd8dc79103d21521cf365df12d335b0f7a Mon Sep 17 00:00:00 2001 From: Martin Smith Date: Mon, 7 Mar 2011 14:11:08 +0100 Subject: qdoc: Added Author> and elements to the metadata. --- tools/qdoc3/ditaxmlgenerator.cpp | 116 ++++++++++++++++++++++++++++++--------- tools/qdoc3/ditaxmlgenerator.h | 1 + tools/qdoc3/node.cpp | 8 +++ tools/qdoc3/node.h | 3 + 4 files changed, 103 insertions(+), 25 deletions(-) diff --git a/tools/qdoc3/ditaxmlgenerator.cpp b/tools/qdoc3/ditaxmlgenerator.cpp index ced14cc..66f4a91 100644 --- a/tools/qdoc3/ditaxmlgenerator.cpp +++ b/tools/qdoc3/ditaxmlgenerator.cpp @@ -1637,11 +1637,7 @@ DitaXmlGenerator::generateClassLikeNode(const InnerNode* inner, CodeMarker* mark */ generateHeader(inner, fullTitle); generateBrief(inner, marker); // - - writeStartTag(DT_prolog); - writeStartTag(DT_metadata); - writeEndTag(); // - writeEndTag(); // + writeProlog(inner,marker); writeStartTag(DT_cxxClassDetail); writeStartTag(DT_cxxClassDefinition); @@ -1764,11 +1760,7 @@ DitaXmlGenerator::generateClassLikeNode(const InnerNode* inner, CodeMarker* mark generateHeader(inner, fullTitle); generateBrief(inner, marker); // - - writeStartTag(DT_prolog); - writeStartTag(DT_metadata); - writeEndTag(); // - writeEndTag(); // + writeProlog(inner,marker); writeStartTag(DT_cxxClassDetail); writeStartTag(DT_cxxClassDefinition); @@ -1909,11 +1901,7 @@ DitaXmlGenerator::generateClassLikeNode(const InnerNode* inner, CodeMarker* mark */ generateHeader(inner, fullTitle); generateBrief(inner, marker); // - - writeStartTag(DT_prolog); - writeStartTag(DT_metadata); - writeEndTag(); // - writeEndTag(); // + writeProlog(inner,marker); writeStartTag(DT_cxxClassDetail); writeStartTag(DT_apiDesc); @@ -2034,12 +2022,8 @@ DitaXmlGenerator::generateClassLikeNode(const InnerNode* inner, CodeMarker* mark generateHeader(inner, fullTitle); generateBrief(inner, marker); // + writeProlog(inner,marker); - writeStartTag(DT_prolog); - writeStartTag(DT_metadata); - writeEndTag(); // - writeEndTag(); // - writeStartTag(DT_cxxClassDetail); writeStartTag(DT_apiDesc); xmlWriter().writeAttribute("spectitle",title); @@ -2148,11 +2132,7 @@ void DitaXmlGenerator::generateFakeNode(const FakeNode* fake, CodeMarker* marker generateHeader(fake, fullTitle); generateBrief(fake, marker); // - - writeStartTag(DT_prolog); - writeStartTag(DT_metadata); - writeEndTag(); // - writeEndTag(); // + writeProlog(fake, marker); writeStartTag(DT_body); if (fake->subType() == Node::Module) { @@ -5548,4 +5528,90 @@ void DitaXmlGenerator::writeDitaMap() endSubPage(); } +/*! + Writes the element for the \a inner node + using the \a marker. The element contains + the element, plus some others. This + function writes one or more of these elements: + + \list + \o + \o + \o + \o + \o + \o + \o + \o + \o + \o + \o + \o + \o + \o + \o + \o + \o + \o + \o + \o + \o + \o + \o + \o + \o + \o + \o + \endlist + + */ +void +DitaXmlGenerator::writeProlog(const InnerNode* inner, CodeMarker* marker) +{ + if (!inner) + return; + writeStartTag(DT_prolog); + + writeStartTag(DT_author); + QString author = inner->author(); + if (author.isEmpty()) + author = "Qt Development Frameworks"; + xmlWriter().writeCharacters(author); + writeEndTag(); // + + writeStartTag(DT_metadata); + writeStartTag(DT_category); + QString category = "Page"; + if (inner->type() == Node::Class) + category = "C++ Class"; + else if (inner->type() == Node::Namespace) + category = "C++ Namespace"; + else if (inner->type() == Node::Fake) { + if (inner->subType() == Node::QmlBasicType) + category = "QML Class"; + else if (inner->subType() == Node::QmlClass) + category = "QML Basic Type"; + else if (inner->subType() == Node::HeaderFile) + category = "Header File"; + else if (inner->subType() == Node::Module) + category = "Module"; + else if (inner->subType() == Node::File) + category = "Example Source File"; + else if (inner->subType() == Node::Example) + category = "Example"; + else if (inner->subType() == Node::Image) + category = "Image"; + else if (inner->subType() == Node::Group) + category = "Group"; + else if (inner->subType() == Node::Page) + category = "Page"; + else if (inner->subType() == Node::ExternalPage) + category = "External Page"; // Is this necessary? + } + xmlWriter().writeCharacters(category); + writeEndTag(); // + writeEndTag(); // + writeEndTag(); // +} + QT_END_NAMESPACE diff --git a/tools/qdoc3/ditaxmlgenerator.h b/tools/qdoc3/ditaxmlgenerator.h index 2384a90..32a9b94 100644 --- a/tools/qdoc3/ditaxmlgenerator.h +++ b/tools/qdoc3/ditaxmlgenerator.h @@ -315,6 +315,7 @@ class DitaXmlGenerator : public PageGenerator void writePropertyParameter(const QString& tag, const NodeList& nlist); void writeRelatedLinks(const FakeNode* fake, CodeMarker* marker); void writeLink(const Node* node, const QString& tex, const QString& role); + void writeProlog(const InnerNode* inner, CodeMarker* marker); private: enum SubTitleSize { SmallSubTitle, LargeSubTitle }; diff --git a/tools/qdoc3/node.cpp b/tools/qdoc3/node.cpp index ee050f5..161c87a 100644 --- a/tools/qdoc3/node.cpp +++ b/tools/qdoc3/node.cpp @@ -771,6 +771,14 @@ void InnerNode::removeChild(Node *child) } } +/*! \fn QString InnerNode::author() const + Returns the author. + */ + +/*! \fn void InnerNode::setAuthor(const QString& author) + Sets the \a author. + */ + /*! Find the module (QtCore, QtGui, etc.) to which the class belongs. We do this by obtaining the full path to the header file's location diff --git a/tools/qdoc3/node.h b/tools/qdoc3/node.h index d1123dc..3869e68 100644 --- a/tools/qdoc3/node.h +++ b/tools/qdoc3/node.h @@ -262,6 +262,8 @@ class InnerNode : public Node NodeList overloads(const QString &funcName) const; const QStringList& includes() const { return inc; } + QString author() const { return author_; } + void setAuthor(const QString& author) { author_ = author; } QStringList primaryKeys(); QStringList secondaryKeys(); const QStringList& pageKeywords() const { return pageKeywds; } @@ -280,6 +282,7 @@ class InnerNode : public Node void removeChild(Node* child); void removeRelated(Node* pseudoChild); + QString author_; QStringList pageKeywds; QStringList inc; NodeList children; -- cgit v0.12