summaryrefslogtreecommitdiffstats
path: root/src/tools/qdoc/htmlgenerator.cpp
Commit message (Collapse)AuthorAgeFilesLines
* QDoc: Added "QML Type" to HTML titles of QML type pages.Jerome Pasion2014-05-141-0/+4
| | | | | | | | -makes it more consistent with the C++ pages. -easier to read for the search engines. Change-Id: I172bdff04e0aa80ee58a903d112585992234d7d7 Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
* qdoc: Improve navigation bar for example filesTopi Reinio2014-03-091-13/+13
| | | | | | | | | | | | | | | | | | | | For example file pages, added a link to the parent example page into the navigation bar. Also, - Removed protectEnc() calls for strings added as Text atoms, this is done automatically when generating the navigation bar output, and doing it twice results in malformed output. - Removed the subtitle from being appended to example file title. The subtitle contains the full path of the file and it's already displayed on the page body, so removing it from the html title + navigation bar makes for a cleaner look without losing any information. Task-number: QTBUG-33022 Change-Id: I3ca942470453379e22f1a4aaec1d9b866d85bb5c Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* Doc: Removed Contents listing for Qt Examples and Tutorials page.Jerome Pasion2014-02-201-1/+1
| | | | | | | | | -Qt Examples and Tutorials page does not need the table of contents. Task-number: QTBUG-36838 Change-Id: Id51ebc7cba7831a24cd9d8e8e6bde7f96bece326 Reviewed-by: Martin Smith <martin.smith@digia.com> Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
* qdoc: Replaced hard-coded href with computed hrefMartin Smith2013-12-031-1/+4
| | | | | | | | | | | | | | | For enum types that have QFlags versions, qdoc was outputting the documentation with a hard-coded link to qflags.html, which only workjed in the single directory mode. When qdoc outputs modular documentation, the href for the link should be "../qtcore/qflags.html" . Now qdoc computes this href correctly before it writes the docs. The href is no longer hard-coded. Task-number: QTBUG-35209 Change-Id: Ibdf5b11dbd063726eb77048de78f8874c65752ca Reviewed-by: Topi Reiniö <topi.reinio@digia.com> Reviewed-by: Lars Knoll <lars.knoll@digia.com>
* qdoc: Part 2 of fix for inheriting abstract QML typesMartin Smith2013-11-011-2/+3
| | | | | | | | | | | | | | | | This fix not only gets the property lists correct but also creates correct links to the property docs. A side effect is that QML properties, methods, and signals whose names begin with "__" are automatically treated as if they are marked \internal. This had been agreed earlier but had not been implemented. It is also required to fix this bug so it is included here. Task-number: QTBUG-33814 Change-Id: I57de1e49774db47cb57c042f181ccc8edec62d13 Reviewed-by: Topi Reiniö <topi.reinio@digia.com> Reviewed-by: Nico Vertriest <nico.vertriest@digia.com> Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* qdoc: Include internal types in the index filesMartin Smith2013-11-011-1/+2
| | | | | | | | | | | | | Internal types can be inherited. Documentation is not created for internal types, but if an internal type is abstract, its properties must be listed on the documentation page of each subtype that inherits the internal type. This fix includes internal types in the index file. Task-number: QTBUG-33814 Change-Id: Ib6ef7cbd92804b3c605009802ddb15d35b32692c Reviewed-by: Topi Reiniö <topi.reinio@digia.com> Reviewed-by: Nico Vertriest <nico.vertriest@digia.com> Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* qdoc: Remove algorithm to find common prefixMartin Smith2013-10-041-45/+13
| | | | | | | | | | | | | HtmlGenerator::generateCompactList() no longer uses an algorithm to find out a common prefix for classes/qml types when generating the alphabetical lists. The common prefix argument is no longer optional. To indicate there is no common prefix, pass an empty string as the common prefix argument. Task-number: QTBUG-33750 Change-Id: I4b44bbcff909fcea5c7bfd58c6796e303086bc68 Reviewed-by: Topi Reiniö <topi.reinio@digia.com> Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* qdoc: Eliminate uses of qmlModuleIdentifier()Martin Smith2013-10-041-4/+4
| | | | | | | | | The QML module identifier is no longer useful. The function to generate it is retained for now. Task-number: QTBUG-32173 Change-Id: Ic811ed432f2059c0370e9e0d86b2e334b5c82a3c Reviewed-by: Martin Smith <martin.smith@digia.com>
* qdoc: Use empty common prefix for alphabetical QML type listsTopi Reinio2013-10-021-8/+8
| | | | | | | | | | | | | This change allows an empty string to be used as a common prefix for class/type compact lists, and uses it for QML types as they do not have a common prefix like public C++ Qt classes do. This fixes the issue with sorting order for QML type lists. Task-number: QTBUG-33715 Change-Id: I28ab689d28017ae28eccbf590d1dbbe107665e33 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com> Reviewed-by: Martin Smith <martin.smith@digia.com>
* Doc: Restore QDoc's use of the \sinceJerome Pasion2013-09-241-21/+6
| | | | | | | | | | -one argument: assume it is the Qt version -more than one argument: copy verbatim Task-number: QTBUG-32172 Change-Id: Iaf5ec538f23abf4d1dfdf50bffcbbdede56d0b22 Reviewed-by: Lars Knoll <lars.knoll@digia.com> Reviewed-by: Martin Smith <martin.smith@digia.com>
* qdoc: Import statement now shows correct versionMartin Smith2013-09-241-1/+7
| | | | | | | | | | The Import statement shown at the top of each QML type page now always gets the version number from the QML module page for the QML type's module. Task-number: QTBUG-32153 Change-Id: I57649c07ea680806bc92ad62fb3bc4d4fb56f717 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* qdoc: \externalpage links are fixedMartin Smith2013-09-231-1/+3
| | | | | | | | | The problem was they were being incorrectly written to and read from the index files. Task-number: QTBUG-33510 Change-Id: Ib0b34265cd22fff5ed88ae2fd5d5d7ea58b3761d Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* Improve qdoc performance.Jędrzej Nowacki2013-09-211-1/+1
| | | | | | | | | | | Valgrind blamed CppCodeMarker::addMarkUp as slow, the patch improves situation by ~12% Use of QStringLiterals instead of const char* reduce amount of allocations on startup. Change-Id: I8737e02785506bba7e23868ab3952eab09d543d2 Reviewed-by: Martin Smith <martin.smith@digia.com>
* Doc: Get QDoc to list the QT variable for namespaces.Jerome Pasion2013-09-051-13/+14
| | | | | | Task-number: QTBUG-32172 Change-Id: Id774b5d5036661a6f6b56b9c68f089031288eacc Reviewed-by: Martin Smith <martin.smith@digia.com>
* Doc: Fixed QDoc's HTML generator to avoid creating blank pages.Jerome Pasion2013-09-041-8/+9
| | | | | | | | | | | -The qdb->findModule() call creates a module node even if the module name is empty. This creates the extra module.html pages in some doc projects. -The fix is to create a condition for calling findModule() Task-number: QTBUG-32990 Change-Id: I6c1d1c53f3814ea483df2cd05b8d39dc14b0fb7b Reviewed-by: Martin Smith <martin.smith@digia.com>
* Doc: Get QDoc to not display the \qtvariable if it is empty.Jerome Pasion2013-08-081-1/+1
| | | | | Change-Id: I5cd2cff23b56180e7bfec7cae84104a16f47fc79 Reviewed-by: Martin Smith <martin.smith@digia.com>
* qdoc: Restore support for output in one directoryMartin Smith2013-08-081-4/+9
| | | | | | | | | | | | | | | | | | | | | | The basic functionality is working. Add these lines to qt-html-templates-offline.qdocconf, or add them to the online version: HTML.nosubdirs = "true" HTML.outputsubdir = "html" Before it opens a .html file for writing, it tests whether the file alread exists. If so, it writes an error message, e.g.: ...platform-notes.qdoc:140: error: HTML file already exists; overwriting .../doc/html/platform-notes-windows.html There are currently nearly 100 files being overwritten for Qt5. Task-number: QTBUG-32580 Change-Id: I02b103fd00b9d1e624665ac518d571acc791be9d Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* Doc: Added \qtvariable command to QDoc.Jerome Pasion2013-08-021-6/+18
| | | | | | | | | | | | | | | | Specifies the QT variable needed in the .pro file. The argument of the command is the qmake QT variable. To use, add "\qtvariable <value>" to a QDoc comment which contains the \module command. QDoc will then associate the class with the QT variable. Only supported for C++ classes at the moment. Part of work done for QTBUG-32172 Task-number: QTBUG-32172 Change-Id: Ia8eea30fcfc771191c23a5f5994a48732959ea49 Reviewed-by: Martin Smith <martin.smith@digia.com>
* Doc: Unified the summary for C++ classes and QML types.Jerome Pasion2013-07-301-15/+255
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | The placement of the header, since, inherits, instantiates, and instantiated-by are now in a table. For C++ classes: Header: #include <class name> Since: <version> Instantiated by: <QML type> Inherits: <parent class> Inherited by: <list of classes> For QML types: To import: import <QML module> Since: <version> Inherited by:<list of QML types> Instantiates: <C++ class> Inherits: <parent QML type> Inherited by: <list of QML types> This is only a part of the work being done for QTBUG-32172. Task-number: QTBUG-32172 Change-Id: Ia9d29e824ef7ab4052ea59c6397b5f8fd24022b9 Reviewed-by: Martin Smith <martin.smith@digia.com> Reviewed-by: Topi Reiniö <topi.reinio@digia.com> Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* Merge "Merge remote-tracking branch 'origin/stable' into dev" into ↵Sergio Ahumada2013-07-241-1/+1
|\ | | | | | | refs/staging/dev
| * Merge remote-tracking branch 'origin/stable' into devFrederik Gladhorn2013-07-231-1/+1
| |\ | | | | | | | | | | | | | | | | | | Conflicts: tests/auto/dbus/qdbusabstractinterface/tst_qdbusabstractinterface.cpp Change-Id: I18a9d83fc14f4a9afdb1e40523ec51e3fa1d7754
| | * Changed digia contact details to */legal, updated licensesTeemu Kaukoranta2013-07-201-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | Scripts are available in internal mkdist repo. Added license tags, updated licenses and copyrights/contacts Change-Id: Ibc734275f3000987eaa4f5c57f19d4e1fda2c479 Reviewed-by: Sergio Ahumada <sergio.ahumada@digia.com>
* | | qdoc: Improve format of obsolete members fileMartin Smith2013-07-231-7/+8
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The link to the class reference page for the class that contains the obsolete members is now embedded in the text description of what the page contains. This change affects both the obsolete members papge and the compatibility members page. Without this change, the link to the class reference page stands off on its own and makes it look like the class itself is obsolete or maintained for compatibility with previous versions. Since this is not the case, the link is now embedded in the text description of the page. Task-number: QTBUG-31379 Change-Id: Ic5f4554c8722ee193f2dfae9efd8adab98f32ca1 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* | | doc: Ensure page name does not changeMartin Smith2013-07-231-1/+1
|/ / | | | | | | | | | | | | | | | | | | | | | | This fix ensures that the page name is set only once. Also included are a few internal documentation changes that bring qdoc's internal terminology up to date. Task-number: QTBUG-31578 Change-Id: Ib52a5a9024533d5a695cee0055bf2bc4d9bc2af9 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* | Merge "Merge branch 'stable' into dev" into refs/staging/devSergio Ahumada2013-07-121-1/+1
|\ \
| * | Merge branch 'stable' into devSergio Ahumada2013-07-111-1/+1
| |\| | | | | | | | | | | | | | | | | | | | | | | | | | | | Conflicts: qmake/generators/mac/pbuilder_pbx.cpp src/corelib/json/qjsonwriter.cpp src/corelib/kernel/qeventdispatcher_blackberry.cpp src/plugins/platforms/cocoa/qcocoacolordialoghelper.mm Change-Id: I24df576c4cbd18fa51b03122f71e32bb83b9028f
| | * Doc: Renamed generated list keyword.Jerome Pasion2013-07-081-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | -"qmlclasses" was used in Qt 4.7 -enables the listing of QML types in a page Task-number: QTBUG-31490 Change-Id: I4f666945067ef1df6e358c488c245792b5aea3ab Reviewed-by: Martin Smith <martin.smith@digia.com>
* | | qdoc: Implement better handling of QML property groupsMartin Smith2013-07-111-69/+47
|/ / | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The \qmlpropertygroup command is added, and qdoc is taught to generate better output for it. The format is, e.g.: \qmlpropertygroup QtQuick2::Item::anchors \qmlproperty AnchorLine QtQuick2::Item::anchors.top \qmlproperty AnchorLine QtQuick2::Item::anchors.bottom \qmlproperty AnchorLine QtQuick2::Item::anchors.left \qmlproperty AnchorLine QtQuick2::Item::anchors.right \qmlproperty AnchorLine QtQuick2::Item::anchors.horizontalCenter \qmlproperty AnchorLine QtQuick2::Item::anchors.verticalCenter \qmlproperty AnchorLine QtQuick2::Item::anchors.baseline \qmlproperty Item QtQuick2::Item::anchors.fill \qmlproperty Item QtQuick2::Item::anchors.centerIn \qmlproperty real QtQuick2::Item::anchors.margins \qmlproperty real QtQuick2::Item::anchors.topMargin \qmlproperty real QtQuick2::Item::anchors.bottomMargin \qmlproperty real QtQuick2::Item::anchors.leftMargin \qmlproperty real QtQuick2::Item::anchors.rightMargin \qmlproperty real QtQuick2::Item::anchors.horizontalCenterOffset \qmlproperty real QtQuick2::Item::anchors.verticalCenterOffset \qmlproperty real QtQuick2::Item::anchors.baselineOffset \qmlproperty bool QtQuick2::Item::anchors.alignWhenCentered Task-number: QTBUG-32341 Change-Id: I4b06a3a061b23680e663e8d4e82ac9863ffd4ecb Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* | Merge remote-tracking branch 'origin/stable' into devFrederik Gladhorn2013-06-271-3/+4
|\| | | | | | | | | | | | | | | Conflicts: configure mkspecs/features/create_cmake.prf Change-Id: I94aea83b83833395d5db399209e0e51b92ef23b5
| * qdoc: Allow colon characters in manifest meta attribute valuesTopi Reinio2013-06-241-3/+4
| | | | | | | | | | | | | | | | | | | | | | | | The current implementation does not allow colons in attribute values, as it's already used as a separator in the form of 'name:value'. This change allows colons in the value string - one use case is to have URL attributes, as in 'imageUrl:qthelp://path.to.image'. Change-Id: I05c5cb32ffc79a39fbe5e4102f7a4b5bdcc2be53 Reviewed-by: Martin Smith <martin.smith@digia.com> Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* | Doc: Fixed QDoc's navigation mechanism.Jerome Pasion2013-06-251-102/+60
|/ | | | | | | | | | | | | | | | | | | | | | | | The HTML pages need to display minimal navigation such as a link to the module landing page or Qt 5's index.html. -new variables available in qdocconf files: navigation.landingpage navigation.homepage navigation.cppclassespage navigation.qmltypespage buildversion The navigation variables are for the new navigation bar. The buildversion variable is to insert documentation build information into the pages. Note about compatibility with Qt Creator docs: The HTML template files for Qt Creator is retained to keep Qt Creator compatible with 5.0.x and 5.1.x. Change-Id: Ibb4d7cada19644204457d822b6b77b2aa7b70f8d Reviewed-by: Martin Smith <martin.smith@digia.com> Reviewed-by: Oswald Buddenhagen <oswald.buddenhagen@digia.com>
* Make qtbase compile with QT_NO_TEXTCODECTasuku Suzuki2013-06-171-0/+10
| | | | | Change-Id: I1614dc08c0dd1950020e415f37c97160431b2336 Reviewed-by: Oswald Buddenhagen <oswald.buddenhagen@digia.com>
* Doc: Rearranged page titles in the <head> of HTML pages.Jerome Pasion2013-06-071-3/+3
| | | | | | | | | | | | | | | | | | | | | | Before: <title>QtMultimedia 5.1: Camera</title> After: <title>Camera | QtMultimedia 5.1</title> "Camera" is page name and "QtMultimedia 5.1" is the assembled project name. -Regular page title is the same. -It's a readability issue to not see the page title right away -New arrangement conforms to Qt Project and blog name format: "<Title> | <Domain>" -Tested with the tw-parser and it looks compatible with the qt-project.org site Change-Id: Iae0eec9e66b5e21285bdad1e525923f60c72e56b Reviewed-by: Sami Makkonen <sami.makkonen@digia.com> Reviewed-by: Nico Vertriest <nico.vertriest@digia.com> Reviewed-by: Venugopal Shivashankar <venugopal.shivashankar@digia.com> Reviewed-by: Martin Smith <martin.smith@digia.com> Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* qdoc: "All Overview and HOWTOs" no longer lists internal pagesMartin Smith2013-05-301-2/+2
| | | | | | | | | | | This page is generated by a function in qdoc that was wwrriten especially for this page. It wasn't checking to see of the group member pages were marked with \internal. Now it does. Task-number: QTBUG-31197 Change-Id: If3f0e90f1a3748c47b3975373047b04d011d6748 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* qdoc: Briefs from other modules now show upMartin Smith2013-05-081-1/+10
| | | | | | | | | | | | | | | The brief text for a documented thing is now output as an attribute of that thing in the module's index file, and it is reconstituted in the thing's tree node, when qdoc reads the module's index file later. Only the verbatim text of the brief is saved in the index file, i.e. no links or other markup. The effect is that brief texts can be used in other modules. Task-number: QTBUG-31021 Change-Id: I932a0c85259b6d1901138f0c0959ddb9815b7db5 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* qdoc: Standardize paths used in example and demo manifest filesTopi Reinio2013-05-081-6/+0
| | | | | | | | | | | | There is no longer any difference in install directories between demos and examples (QT_INSTALL_DEMOS is obsolete and points to the same dir as QT_INSTALL_EXAMPLES for compatibility). This change removes any special handling of demos' paths used in manifest xml, enabling the demos to be visible in Creator welcome mode as well. Change-Id: I5afdf578a42d001fab05979d3ea1102fd52b51da Reviewed-by: Martin Smith <martin.smith@digia.com> Reviewed-by: Thomas Hartmann <Thomas.Hartmann@digia.com>
* qdoc: Adjust regexp that generates tags from module namesTopi Reinio2013-04-261-1/+1
| | | | | | | | | | | Use a slightly better regular expression for splitting module names into tags used for example manifest files. This will correctly split words with consecutive capital letters (e.g. QtDBus) Change-Id: I1320e08a1fbd44f718b82a1fcfea19eabca035fc Reviewed-by: Martin Smith <martin.smith@digia.com>
* qdoc: Include words from the module name as tags in example manifestTopi Reinio2013-04-191-0/+13
| | | | | | | | | | | | | | | | This change adds words from the module name (QHP 'project' name defined in .qdocconf files) as tags for the module's examples. This makes searching for examples easier in Qt Creator: For example, typing 'multimedia' will list all examples in Qt Multimedia and Qt Multimedia Widgets modules. Other minor changes: - Exclude 'qt' as a tag (not needed) - Exclude one-character strings as tags Task-number: QTBUG-28720 Change-Id: I53751b7a87ff39ee7b648f865c9090c52444de76 Reviewed-by: Martin Smith <martin.smith@digia.com>
* qdoc: Add index of obsolete members to obsolete pageMartin Smith2013-04-171-17/+41
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | qdoc has been modified to emit a compact list of the classes that have one or more obsolete members. The command is: \generatelist obsoletecppmembers This generates an index of all such classes, where each class name is a link to the class's subpage of obsolete members. A class's subpage of obsolete members is also accessible from the class's reference page, but now it is also accessible from this index. Also, The command shown has been added to the page obsoleteclasses.html in the generated output. This page already contains the index of obsolete classes. Currently, no such output is generated for QML types and QML types with obsolete members. But qdoc does accept commands for those: \generatelist obsoleteqmltypes and \generatelist obsoleteqmlmembers ...but qdoc doesn't know what to do with those commands yet. Task-number: QTBUG-30270 Change-Id: If19a3b977f64c948e4bd6f14a9e0a287419baa8a Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* qdoc: List of all members subpage redesignedMartin Smith2013-03-221-2/+32
| | | | | | | | | | | | | | | | | | | | | | | | | | The subpage listing all the members of a QML type, including the inherited members, was trying to use an old format that works ok for C++ classes but is not optimal for QML types. The redesigned format for QML types still lists all the members but it lists the members for each base type in a separate list. The members for a QML type that has been marked as abstract are listed with the members of the type that inherits the abstract type. This fix does not fix QTBUG-30111, which will be fixed in a separate commit. This means that some links on the subpage generated by this change will be links to a page that doesn't actually contain any documentation for the linked member. But it will eventually. Task-number: QTBUG-30114 Change-Id: I8ae4227d1eaecdbc24a4ac9b8119f0ced2cdee92 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* qdoc: QML Inheritance is not resolved correctly.Martin Smith2013-02-201-1/+4
| | | | | | | | | | This change adds some QML property, signal, and method data to the .index file. It also provides more robust resolving of QML inheritance for qml types. Task-number: QTBUG-29778 Change-Id: Iaefd64227913a19f427b21e904ca5e32c82d7b29 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* Doc: Support for meta-content in manifest XML filesTopi Reinio2013-02-151-5/+55
| | | | | | | | | | | | | | | | | | This change makes qdoc support additional attributes and tags written to example/demo manifest files. The goal is to enable highlighting of selected items, as well as having additional content to make searching for specific categories work better in Qt Creator welcome screen. This meta-content is stored in manifest-meta.qdocconf, which is loaded globally for all modules. Tag handling is also changed to use a QSet to eliminate possible duplicate tags. Task-number: QTBUG-29354 Change-Id: I2c4b2dff6229172efbecc2bfc1c269017edc4d56 Reviewed-by: Martin Smith <martin.smith@digia.com> Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* qdoc: inherited members do not show up for QML componentsMartin Smith2013-02-131-1/+1
| | | | | | | | | | | | | | | | | | | | | | | This was a regression bug owing to a big qdoc cleanup for Qt5. But the way QML inheritance had been handled was not a good design, so it has been changed here. When a .qml file is parsed by qdoc, the base type of the QML component is detected, and its name is stored in qdoc's tree node for the component. After qdoc has parsed all the QML files, it traverses the tree, and for each QML component that has a base type name but no base type node pointer yet, it searches the tree for the base type node and stores the pointer to the node in the node for the components. Then when the output generator generates the doc page for the component, it has access to all the inherited members in the base type. Task-number: QTBUG-29569 Change-Id: Ib4958d05f55fa48a572f8ca51ffd57712f29bbc7 Reviewed-by: J-P Nurmi <jpnurmi@digia.com> Reviewed-by: Topi Reiniö <topi.reinio@digia.com> Reviewed-by: Martin Smith <martin.smith@digia.com>
* Update copyright year in Digia's license headersSergio Ahumada2013-01-181-1/+1
| | | | | Change-Id: Ic804938fc352291d011800d21e549c10acac66fb Reviewed-by: Lars Knoll <lars.knoll@digia.com>
* qdoc: Make links to \target work intermoduleMartin Smith2012-12-121-0/+4
| | | | | | | | | | | | | | \target sets up a unique target that should be accessible with \l across module boundaries. This was not working across module boundaries. Now it has been fixed, and it is one way of handling the problem described in the referenced bug report. Task-number: QTBUG-28244 Change-Id: I541f409b998f84b2b8dcf66751762cf07f9f108b Reviewed-by: Topi Reiniö <topi.reinio@digia.com> Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* qdoc: Don't include internal items in annotated listsMartin Smith2012-11-291-1/+9
| | | | | | | | | Now things that are marked internal oe whose parent is marked internal won't appear in annotated lists. Task-number: QTBUG-28274 Change-Id: I14ea96e223640cad45e7e4249a3e1fc0642bd9c3 Reviewed-by: J-P Nurmi <jpnurmi@digia.com>
* Fix filesToOpen in example manifests.Eike Ziller2012-11-271-2/+2
| | | | | | Task-number: QTBUG-27801 Change-Id: Ibfe1f3f2f3ba9d00698d3465fb0950e77a63bd4e Reviewed-by: Martin Smith <martin.smith@digia.com>
* qdoc: Listing group members across modulesMartin Smith2012-11-271-81/+39
| | | | | | | | | | | | | | This is a first attempt at fixing the problem, but it probably is not the entire solution. The problem requires adding attributes to the index files and then reusing them when the index files are read. The same problem will be affecting the module lists themselves, but that is not fixed in this update. Task-number: QTBUG-28036 Change-Id: I8593d5b9446e51a5204b6c71f8c4f2b63f445972 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* Change license header from Nokia to DigiaSergio Ahumada2012-11-261-1/+1
| | | | | Change-Id: I2be215284d7670f60f8b5838fce1e6832dde2270 Reviewed-by: Martin Smith <martin.smith@digia.com>
* Allow qdocconf to specify where the examples are located in install.Eike Ziller2012-11-261-4/+6
| | | | | | | | | | | | | | | | | | | | | | | | We have qdoc configurations for the different qtbase libraries and modules now, which specify e.g. "../../../examples/opengl" for the exampledirs. That means that qdoc finds examples like "2dpainting/2dpainting.pro" which is then installed into "[QT_INSTALL_EXAMPLES]/opengl/2dpainting/2dpainting.pro". (At the moment even into "[QT_INSTALL_EXAMPLES]/qtbase/opengl/...", which will be changed to match the structure in source.) In order for Qt Creator to find the examples, qdoc must write the path behind [QT_INSTALL_EXAMPLES] into the example manifest file. This patch introduces "examplesinstallpath" that allows qdoc configs to specify the missing part, e.g. the opengl qdocconf can add examplesinstallpath = opengl to tell qdoc that the examples will be installed into "[QT_INSTALL_EXAMPLES]/opengl/" Task-number: QTBUG-27801 Change-Id: Idf518e16d3ca0f9522b084e92f34725b93e9d11f Reviewed-by: Martin Smith <martin.smith@digia.com>