summaryrefslogtreecommitdiffstats
path: root/src/tools/qdoc
Commit message (Collapse)AuthorAgeFilesLines
* Doc: minor language and layout editsNico Vertriest2013-08-291-3/+8
| | | | | | | Task-number: QTBUG-31801 Change-Id: I99043ba5d1a417e093ae2e4bc7d2967ec9d095fc Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* Doc: added excludedirs to qdocconf example.Nico Vertriest2013-08-231-0/+18
| | | | | | | | | Corrected style issues pointed out in review. Task-number: QTBUG-31801 Change-Id: Ibbc4e5f8dcd8ca129ae945b5e62b15daed47d86d Reviewed-by: Martin Smith <martin.smith@digia.com>
* Doc: minimal qdocconf file with commentsNico Vertriest2013-08-231-0/+86
| | | | | | | Task-number: QTBUG-31801 Change-Id: Ia94989b066ab2cd4d6dbf64261b5d9b4207db12a Reviewed-by: Martin Smith <martin.smith@digia.com>
* Doc: qtgui configuration file with commentsNico Vertriest2013-08-201-0/+292
| | | | | | | | Task-number: QTBUG-31801 Change-Id: I225edf67f586cc5822269c643020d5666465712d Reviewed-by: Martin Smith <martin.smith@digia.com> Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* Doc: a minimal qdocconf file with commentsNico Vertriest2013-08-091-0/+78
| | | | | | | | Task-number: QTBUG-31801 Change-Id: I3aa91c961ba5b3d4e7c69560673757120a850d42 Reviewed-by: Martin Smith <martin.smith@digia.com> Reviewed-by: Mitch Curtis <mitch.curtis@digia.com>
* Doc: preliminary review of qdoc-manual.qdocNico Vertriest2013-08-081-323/+298
| | | | | | | | | | | | | - syntax - grammar - writing guidelines - spelling - added contents for \\note Task-number: QTBUG-31801 Change-Id: I9df1af270acd7fbad39048a47b883f3002e168e4 Reviewed-by: Martin Smith <martin.smith@digia.com> Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
* Changed digia contact details to */legal, updated licensesTeemu Kaukoranta2013-07-206-6/+6
| | | | | | | | 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>
* Fix typo in qdoc's messages.Takumi Asaki2013-07-171-2/+2
| | | | | | Change-Id: I837eaef4fb114c20a75ffc188b49aa612f07f507 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@digia.com> Reviewed-by: Martin Smith <martin.smith@digia.com>
* 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: 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>
* Make qtbase compile with QT_NO_TRANSLATIONTasuku Suzuki2013-06-185-87/+2
| | | | | Change-Id: Iaa52ba41218b3ec8f36f0052230e0c2cc31c3ba5 Reviewed-by: Oswald Buddenhagen <oswald.buddenhagen@digia.com>
* Make qtbase compile with QT_NO_TEXTCODECTasuku Suzuki2013-06-176-0/+34
| | | | | Change-Id: I1614dc08c0dd1950020e415f37c97160431b2336 Reviewed-by: Oswald Buddenhagen <oswald.buddenhagen@digia.com>
* Merge remote-tracking branch 'origin/release' into stableFrederik Gladhorn2013-06-126-46/+76
|\ | | | | | | Change-Id: If29ca1b27da4592d40a7678837c359f75dac1209
| * Qdoc: replaced example file qt.qdocconf with qtgui.qdocconfNico Vertriest2013-06-122-35/+65
| | | | | | | | | | | | Task-number: QTBUG-31574 Change-Id: Idf8509395dd5f16c696473d1eeb91fb86f2b97e7 Reviewed-by: Martin Smith <martin.smith@digia.com>
| * Doc: Fixed snippet issues in QDoc documentationTopi Reinio2013-06-104-11/+11
| | | | | | | | | | | | | | | | | | | | | | QDoc uses .qdoc files as snippets in other .qdoc files. These snippet .qdoc files are also parsed, which is not the intent. This change resolves the issue by renaming the files to have a different extension. Task-number: QTBUG-31574 Change-Id: I399c8b714478b9c4b8fbe2db53f601e6a1386cea Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* | qdoc: qdoc was confused by namespace and module with same nameMartin Smith2013-06-117-44/+86
|/ | | | | | | | | | | | | When qdoc searched for QtConncurrent::blockingFilter(), it found the module node for QtConcurrent instead of the namespace. This was because qdoc wasn't given specific enough instructions on how to perform the search. Now it searches for the namespace first, then the C++ class, then the module. Task-number: QTBUG-31535 Change-Id: I4f8aec503903508789738f2a77c76f47a3e80a93 Reviewed-by: Jerome Pasion <jerome.pasion@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: excludedirs works againMartin Smith2013-05-311-1/+1
| | | | | | | | | | | | It was comparing an absolute path to a relative path. These could never be the same. Instead of the relative path, it now gets the canonical absolute path, so the comparison succeeds when it should. Task-number: QTBUG-31404 Change-Id: I9c482d4649d493ce6d4f9a522cb61f2c8a5eb21f Reviewed-by: Topi Reiniö <topi.reinio@digia.com> Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* qdoc: Handle collision nodes when building index filesTopi Reinio2013-05-302-4/+12
| | | | | | | | | | | | | | | | | | | Currently qdoc skips collision nodes (and their children) when reading index files. This means that cross-linking between modules does not work for nodes that are defined under a collision page node. Most notably, the QML global object 'Qt' cannot be linked to from outside Qml module as it collides with Qt namespace. This change fixes the issue by skipping collision nodes and only processing their children when writing index files. In addition, we need to adjust the function that searches for nodes to the possibility that there may be multiple nodes with the same name but different type. Task-number: QTBUG-31096 Change-Id: Ic71d714f85539d8537021c73d8f1a527006a6f23 Reviewed-by: Martin Smith <martin.smith@digia.com>
* qdoc: "All Overview and HOWTOs" no longer lists internal pagesMartin Smith2013-05-302-4/+4
| | | | | | | | | | | 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: QML property lists were not shownMartin Smith2013-05-301-2/+5
| | | | | | | | | | | | For grouped properties, the property list in the summary section was not shown owing to a bug introduced when implementing the abstract base class concept for QML types. This has now been fixed. Task-number: QTBUG-31317 Change-Id: Idc2344539ecf3da53e1be6816f59e01922c5c6fc Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* qdoc: Brief attribute was written incorrectlyMartin Smith2013-05-201-3/+15
| | | | | | | | | | | | | The brief attribute for a C++ property was being written after the <property> tag had been closed. This has been fixed by explicitlty writing the brief attribute for each XML tag that has a brief text to write. Task-number: QTBUG-31149 Change-Id: Ic3857b8fa50cfb84536b838771751d8b92ed590e Reviewed-by: Friedemann Kleint <Friedemann.Kleint@digia.com> Reviewed-by: Topi Reiniö <topi.reinio@digia.com> Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* qdoc: Don't try to add html files for images in .qhpTopi Reinio2013-05-101-0/+1
| | | | | | | | | | | | | | | QDoc adds document nodes as files into the .qhp, including nodes with image subtype. This will generate a lot of unnecessary warnings for missing '<image>.png.html' files from qhelpgenerator when running 'make docs'. This change makes qdoc skip the above step for image nodes to remove the warnings. The images are still always added to .qch in a separate step. Change-Id: Ib07fc8a3ce65f5d4dd700daf00f5f6a36f74a696 Reviewed-by: Martin Smith <martin.smith@digia.com> Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* qdoc: Documentation for QMetaObject::Connection now appearsMartin Smith2013-05-081-1/+17
| | | | | | | | | | | | | | | | | qdoc's faux C++ parser did not recognize class declarations of the form: class Name1::Name2 { ... }; ...where class Name2 is nested in class Name1. Now it does, but this fix doesn't handle deeper nestings. doc needs a proper C++ parser. Task-number: QTBUG-28664 Change-Id: I5adf88cc1b2ce03f5565250734416bf9592914b5 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* qdoc: Briefs from other modules now show upMartin Smith2013-05-085-2/+37
| | | | | | | | | | | | | | | 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: Fix warning about unused variable 'high'.Friedemann Kleint2013-05-071-2/+0
| | | | | | | Introduced by a2892ad1d7584de62a1356812a4f9348f37e1d29 . Change-Id: If41d5990724fd75d27e29987ad19bda50e29518f Reviewed-by: Martin Smith <martin.smith@digia.com>
* qdoc: Fix missing images in 09-qdoc-commands-includingimages.htmlSergio Ahumada2013-05-071-1/+2
| | | | | | | Change-Id: I50936f2cab4e6b8a37cf2b13211f99afca4032ff Reviewed-by: Topi Reiniö <topi.reinio@digia.com> Reviewed-by: Venugopal Shivashankar <venugopal.shivashankar@digia.com> Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* qdoc: The \wrapper command is addedMartin Smith2013-05-076-4/+34
| | | | | | | | | | | | | | | | | | If \wrapper appears in a \class comment or a \qmltype comment, qdoc will not print warnings when it finds public members of the class or the QML type that are not documented. The \wrapper command is added to several opengl classes. This reduces the number of qdoc warnings by several thousands. Task-number: QTBUG-30755 Change-Id: Iba1eebc1590ccf54100e40fe91423240c1b3d09d Reviewed-by: Topi Reiniö <topi.reinio@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: Config class uses current path for each path varMartin Smith2013-04-305-25/+10
| | | | | | | | | | The Config class is further modified to make use of the current directory information it stores with each configuration variable. Task-number: QTBUG-30725 Change-Id: I34c845e6c05d7868266324f1d54e56f94d709f95 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* qdoc: Config class keeps track of current pathMartin Smith2013-04-306-180/+221
| | | | | | | | | | | | | | | The Config class is modified to build a single multimap containing a record for each variable found in each .qdocconf file. Each reacord contains not only the name and value of the variable, but also its location in the qdocconf file it was read from and the path to that file. This single multimap replaces 3 maps in the Config class. Task-number: QTBUG-30725 Change-Id: I049a69790f943b24c014a24b55b2b39725a1b56f Reviewed-by: Jerome Pasion <jerome.pasion@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-1715-92/+209
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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>
* Remove unused private members [tools]Thiago Macieira2013-04-112-2/+0
| | | | | | | | | | | | | | | Apple Clang 4.2 caught private members that aren't used in a class with no friends. Since this code is in a tool, there's no binary compatibility requirement. databaseinfo.h:71:13: error: private field 'driver' is not used [-Werror,-Wunused-private-field] quoter.h:86:10: error: private field 'validRegExp' is not used [-Werror,-Wunused-private-field] qmlvisitor.h:123:11: error: private field 'tree' is not used [-Werror,-Wunused-private-field] Change-Id: Iba9995f28ddef983c9ffc1dc551f042539252704 Reviewed-by: Alan Alpert <aalpert@blackberry.com> Reviewed-by: Olivier Goffart <ogoffart@woboq.com> Reviewed-by: Thiago Macieira <thiago.macieira@intel.com>
* qdoc: Removed dead code from qdocMartin Smith2013-04-083-17/+10
| | | | | | | | | | | | | | | | The documentation used to have "Main Classes" list for C++ classes, and qdoc kept track which classes were supposed to be listed as "main" classes. This is no longer used, so this change removes the code that marked a C++ class as a main class and tested whether a class was a main class. This dead code was seen while preparing the way for changing qdoc to output a documentation page for obsolete C++ classes and functions and obsolete QML types and functions. Task-number: QTBUG-30511 Change-Id: Iccc31b46b7c3c144038372cad4771d974f207937 Reviewed-by: Topi Reiniö <topi.reinio@digia.com> Reviewed-by: Laszlo Papp <lpapp@kde.org> Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* Merge remote-tracking branch 'origin/release' into stableFrederik Gladhorn2013-04-031-1/+1
|\ | | | | | | Change-Id: Icedabda08961326a0a447ec71f1b0f0f5df075eb
| * qdoc: Use 'org.qt-project.' prefix in namespaceSergio Ahumada2013-03-271-1/+1
| | | | | | | | | | | | | | Standarize the qdoc namespace to match all the others configurations. Change-Id: I364d41f20084b77ab3805e72c870147c05da1d42 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* | make bootstrapping of qdoc optionalOswald Buddenhagen2013-04-031-1/+2
| | | | | | | | | | | | | | the weird QLibraryInfo dependency is gone. Change-Id: Iebaa5af6bc529999a2415b2ce3d2a5dca362dd5a Reviewed-by: Thiago Macieira <thiago.macieira@intel.com>
* | add qcryptographichash to bootstrap libOswald Buddenhagen2013-04-031-4/+3
| | | | | | | | | | | | | | needed to make qdoc bootstrapping optional Change-Id: Ie630d129ed038fd90078197588a6df723eddf553 Reviewed-by: Thiago Macieira <thiago.macieira@intel.com>
* | fix non-bootstrapped buildOswald Buddenhagen2013-04-021-1/+1
| | | | | | | | | | Change-Id: Ic615dc3bee423e2bb05798ce861ca809ac89a23c Reviewed-by: hjk <hjk121@nokiamail.com>
* | move the setup of QT_INSTALL_DOCS from qdoc to qt_docs.prfOswald Buddenhagen2013-04-021-12/+0
| | | | | | | | | | | | | | | | | | | | this is a qt specific option and really should not be hard-coded. also, the implementation used undocumented api that is internal to the bootstrapped process, which made it impossible to de-bootstrap it. Change-Id: If706960671744e64a9a7c366437977a800a6058e Reviewed-by: Joerg Bornemann <joerg.bornemann@digia.com>
* | qdoc: Show signals inherited from abstract base typesMartin Smith2013-03-262-3/+4
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | qdoc was not including QML signals in the documentation for a QML type, when the signals were inherited from a QML type that had been marked abstract. This is now fixed. Additionally, the QML type qualifier is not shown in the header for the documentation for a member of a QML type. The type qualifier was redundant information, and it was incorrect for members inherited from abstract base types. Task-number: QTBUG-30111 Change-Id: I73aef40f69a15bca6948bf36596b83800d248b1f Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* | Silence warning by Apple Clang 4.2 about adding an integer to a stringThiago Macieira2013-03-261-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | It gives a good suggestion on what to do and even shows us how to do it. doc.cpp:2681:34: error: adding 'int' to a string does not append to the string [-Werror,-Wstring-plus-int] result += " " + (column % tabSize); ~~~~~~~~~~~^~~~~~~~~~~~~~~~~~~~ doc.cpp:2681:34: note: use array indexing to silence this warning result += " " + (column % tabSize); ^ & [ ] Change-Id: Idd2157ab04cd2a3e37a1336bb5e8926ddc14823a Reviewed-by: Tor Arne Vestbø <tor.arne.vestbo@digia.com>
* | qdoc: List of all members subpage redesignedMartin Smith2013-03-224-22/+124
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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>
* | Initialize gen_ variableMontel Laurent2013-03-221-0/+1
| | | | | | | | | | | | Change-Id: I87e0b2e11670ea71da8e4d2f718dc97dd32dd57d Reviewed-by: Martin Smith <martin.smith@digia.com> Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* | Merge branch 'dev' into stableOswald Buddenhagen2013-03-2020-1466/+1888
|\ \ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This starts Qt 5.1 release cycle Conflicts: src/gui/text/qfontdatabase.cpp src/gui/text/qharfbuzz_copy_p.h src/widgets/kernel/qapplication.cpp src/widgets/kernel/qcoreapplication.cpp Change-Id: I72fbf83ab3c2206aeea1b089428b0fc2a89bd62b
| * | update qml parser to current version from qtdeclarativeOswald Buddenhagen2013-03-1419-1465/+1883
| | | | | | | | | | | | | | | Change-Id: Ic623614aa3c63197e44bf1ae04001997fe7deaac Reviewed-by: Martin Smith <martin.smith@digia.com>
| * | don't bootstrap tools when not necessaryOswald Buddenhagen2013-03-141-0/+1
| | | | | | | | | | | | | | | | | | | | | | | | bootstrapping is only necessary if we are cross-compiling or have a circular build dependency. Change-Id: I17244457652ca9d4fc797043e57070c2ae3ee5d1 Reviewed-by: Joerg Bornemann <joerg.bornemann@digia.com>
| * | Merge remote-tracking branch 'origin/stable' into devFrederik Gladhorn2013-03-065-14/+43
| |\ \ | | | | | | | | | | | | | | | | | | | | | | | | | | | | Conflicts: src/plugins/platforms/qnx/qqnxscreen.cpp src/plugins/platforms/windows/qwindowsdialoghelpers.cpp Change-Id: Ib64f21c077b54f2291d19187590bfe869b98477a
generated by cgit v1.2.3 (git 2.25.1) at 2024-05-07 09:08:37 +0000