summaryrefslogtreecommitdiffstats
path: root/src/tools/qdoc
Commit message (Collapse)AuthorAgeFilesLines
* qdoc: Further changes to the QML specializationMartin Smith2012-04-283-63/+87
| | | | | | | | | | The <qmlPropertyGroup> tag now has an id attribute of the form "id-qml-propertygroup-xxx" where the xxx is the property name. //This should be unique within the document. Change-Id: I20b30266dbe92b85b60400de30ebf9b1f1e292ea Reviewed-by: Casper van Donderen <casper.vandonderen@nokia.com>
* QDoc: Pretend that .qtx and .qtt files are .qdoc files.Casper van Donderen2012-04-271-1/+1
| | | | | | Change-Id: I2b530e526d2c1f5102960dab4991ceade414f1eb Reviewed-by: Ed Baak <ed.baak@nokia.com> Reviewed-by: Peter Yard <peter.yard@nokia.com>
* QDoc: Disambiguate prev and next links in html source.Casper van Donderen2012-04-261-2/+2
| | | | | Change-Id: Iaa82b9b6de71b577a44eae86eb6847c07d068670 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@nokia.com>
* QDoc: Implement -installdir CLI option for module cross-linking.Casper van Donderen2012-04-254-3/+22
| | | | | | | | | | | | QDoc needs to know the final location of the installed documentation to generate correct relative links between the modules. Normally you can use QLibraryInfo::DocumentationPath for this, but since QDoc gets compiled during Qt bootstrapping QLibraryInfo is not available yet. The -installdir option still allows us to specify QLibraryInfo::DocumentationPath on the command line. Change-Id: Ic4729f4daad112f0d175931467cf09cfcf5145a3 Reviewed-by: Martin Smith <martin.smith@nokia.com>
* qdoc: Further changes to the QML specializationMartin Smith2012-04-242-63/+93
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 1. Body elements to include type, property, method, signal, enum info, so: qmlDetail to - qmlTypeDetail - qmlPropertyDetail - qmlEnumerationDetail - qmlMethodDetail - qmlSignalDetail 2. Same thing for a section that contains elements specialized for QML, so qmlDef to - qmlTypeDef - qmlPropertyDef - qmlEnumerationDef - qmlMethodDef - qmlSignalDef Rationale for both items above is that otherwise the body and section content models would have to be exactly the same for a type, property, method, etc. 3. For the import statement use: <qmlImportModule> <apiItemName>QtGraphicalEffects</apiItemName> <apiData>1.0</apiData> </qmlImportModule> So we have an element indicating that this is for the import statement, not an outputclass. And no need to specialize the elements inside it as we know from the ancestor (qmlImportModule) what they're for. <qmlImportModule> to be specialized from apiDef. 4. The 'description' section name doesn't need to be specialized further from the API ref. DTDs so <qmlDesc> should be <apiDesc> The content model for the 'description' section would be similar to that of a normal DITA section, specialized into apiDesc in the API ref. DTDs, so we don't need to rename it for QML. 5. We need a separate element for the since information. <qmlSince> <apiItemName>QtGraphicalEffects</apiItemName> <apiData>1.0</apiData> </qmlSince> 6. Public identifier should be like this for a type: -//NOKIA//DTD DITA QML Type//EN Not like this: -//NOKIA//DTD DITA QML API Type Reference v0.1.0//EN Change-Id: Ie9047965bf32a2e3e9339eb743f2019cb38c88e4 Reviewed-by: Casper van Donderen <casper.vandonderen@nokia.com>
* qdoc: Don't write '...' for empty <apiName>Martin Smith2012-04-231-2/+2
| | | | | | | qdoc now <apiName/>, when there is no name. Change-Id: I0aa85eef633776f691c9e2238514194cf89b8a8f Reviewed-by: Casper van Donderen <casper.vandonderen@nokia.com>
* qdoc: Update qdoc to use QML spec for DITAMartin Smith2012-04-234-190/+285
| | | | | | | | qdoc now generates DITA XML from QML docs according to the QML specialization. Change-Id: I51d93c2ab3b1deefab9bbedcd2e752f49648809f Reviewed-by: Casper van Donderen <casper.vandonderen@nokia.com>
* QDoc: Support -indexdir on CLI and depends in qdocconf.Casper van Donderen2012-04-232-0/+57
| | | | | | | | | You can now specify a list of modules in the "depends" qdocconf variable. This stringlist is then used by the -indexdir option to specify in which directory to search for [depends entry]/[depends entry].index Change-Id: Icab6dd0133e180ac04365da9605743def6fb754d Reviewed-by: Martin Smith <martin.smith@nokia.com>
* QDoc: Remove the text around previous and next page links.Casper van Donderen2012-04-201-4/+4
| | | | | | | | | Previously we printed "[Previous: <link>] and [Next: <link>]. After this change we only print the <link>, which should include an icon. Change-Id: I30d0c7d53b70ec2e537774d57a4ac9af01b26b16 Reviewed-by: Martin Smith <martin.smith@nokia.com> Reviewed-by: Leena Miettinen <riitta-leena.miettinen@nokia.com>
* QDoc: Generate index file for DITAXML.Casper van Donderen2012-04-198-198/+209
| | | | | | | | | | | This change moves the fullDocumentLocation function to the generator base-class and adds generateIndex to the DITAXML Generator. All function calls to fullDocumentLocation are now handled by the static function in the base-class which will use the file extension from the currently active generator (either DITAXML or HTML). Change-Id: I24ce09c05a63eb5980b1243c58990e7ce9d42036 Reviewed-by: Martin Smith <martin.smith@nokia.com>
* QDoc: Write subclasses of namespaces in automatic ditamap.Casper van Donderen2012-04-171-13/+22
| | | | | | | Now we also write the subclasses of namespaces sorted to qt.ditamap. Change-Id: I4a4376bac208b9bacd5a2ddd5265faef13dc2eba Reviewed-by: Martin Smith <martin.smith@nokia.com>
* Merge remote-tracking branch 'origin/master' into api_changesLars Knoll2012-04-1610-338/+350
|\ | | | | | | | | | | | | | | | | | | | | | | | | | | Conflicts: configure src/corelib/io/qurl.cpp src/gui/kernel/qwindow.cpp src/tools/moc/generator.cpp src/widgets/kernel/qwidget_qpa.cpp src/widgets/styles/qstyle.h src/widgets/widgets/qtabbar.cpp tests/auto/corelib/codecs/utf8/tst_utf8.cpp Change-Id: Ia457228d6f684ec8184e13e8fcc9d25857b1751e
| * QDoc: add missing newline characters in qdoc -help.Casper van Donderen2012-04-141-2/+2
| | | | | | | | | | Change-Id: Ibd50091693be393c6b479d6ca8927ba1ed578709 Reviewed-by: Martin Smith <martin.smith@nokia.com>
| * qdoc: Fixed bugs causing invalid DITA XMLMartin Smith2012-04-144-154/+186
| | | | | | | | | | | | | | | | | | | | | | Fixed a bug in qdoc that caused too many end elements to be generated. Also fixed some doc errors that caused invalid DITA to be generated. Task nr: QTBUG-25302 Change-Id: Ifbbf457d28c51c2691a252888447739da7713bc9 Reviewed-by: Martin Smith <martin.smith@nokia.com> Reviewed-by: Casper van Donderen <casper.vandonderen@nokia.com>
| * QDoc: Fix infinite loop when finding items in ditamaps.Casper van Donderen2012-04-131-1/+2
| | | | | | | | | | Change-Id: Ic033676e21a252db07543fccba0d2a41f4b52294 Reviewed-by: Martin Smith <martin.smith@nokia.com>
| * QDoc: Generate missing image error.Casper van Donderen2012-04-122-0/+2
| | | | | | | | | | Change-Id: I98faf3b3422fa0a7ebd3f65c7ba64e6dc31bad86 Reviewed-by: Martin Smith <martin.smith@nokia.com>
| * QDoc: Fix no-examples option.Martin Smith2012-04-111-3/+5
| | | | | | | | | | | | | | | | This was accidentally removed in the big change regarding searching in the internal QDoc tree. Change-Id: I2496d7497d239f1ec5fbd01be6a918c1ef29fc95 Reviewed-by: Casper van Donderen <casper.vandonderen@nokia.com>
| * qdoc: Fixed to report read-only QML properties correctlyMartin Smith2012-04-117-179/+154
| | | | | | | | | | | | | | | | | | | | | | | | Now the default for a QML property is writable. If qdoc can't detect the actual read-only status, writable is assumed. There were some cases where qdoc could not determine the actual read-only/writable status for a QML property. In these cases, qdoc reported read-only because the default was read-only, which was not optimal. Change-Id: I55aeb2bedcde92a414f4d48a8d995e5e9dbca5da Reviewed-by: Casper van Donderen <casper.vandonderen@nokia.com>
* | Merge remote-tracking branch 'origin/master' into api_changesOswald Buddenhagen2012-04-1023-904/+1214
|\| | | | | | | | | | | | | | | | | | | Conflicts: configure src/widgets/styles/qwindowsxpstyle.cpp tests/auto/gui/kernel/qwindow/qwindow.pro tests/auto/gui/kernel/qwindow/tst_qwindow.cpp Change-Id: I624b6d26abce9874c610c04954c1c45bc074bef3
| * Fix warnings about truncations in constants.Friedemann Kleint2012-04-031-2/+2
| | | | | | | | | | Change-Id: I46872c5b2866454112092c1ec5efbfe15db5af33 Reviewed-by: Thiago Macieira <thiago.macieira@intel.com>
| * qdoc: findNodeRecursive() was called with a null start nodeMartin Smith2012-04-032-2/+14
| | | | | | | | | | | | | | | | | | | | | | This occurred in several places. They have all been corrected to start at the tree root, when the start node passed is null. Task nr: QTBUG-25146 Change-Id: I5d75db0626451d30e8be8de5605036ba168f2a14 Reviewed-by: Casper van Donderen <casper.vandonderen@nokia.com>
| * QDoc documentation: modified the instructions for documenting signals.Jerome Pasion2012-04-031-16/+9
| | | | | | | | | | | | | | | | -we document signals, not signal handlers. Change-Id: I7d52223a393ff0530ead06dfb8a80479e34fd362 Reviewed-by: Casper van Donderen <casper.vandonderen@nokia.com> Reviewed-by: Martin Smith <martin.smith@nokia.com>
| * qdoc: Don't lower case <shortdesc> in DITA.Martin Smith2012-04-021-32/+31
| | | | | | | | | | | | | | | | The first letter of a short description no longer has a lower case letter. Change-Id: I98f04d2feba070a0a77161316773306386cc6b67 Reviewed-by: Casper van Donderen <casper.vandonderen@nokia.com>
| * qdoc: Add the \hr commandMartin Smith2012-04-025-0/+16
| | | | | | | | | | | | | | | | Now you can out put a horizontal line anywhere in your text. Change-Id: I9b8bbbd6aa312e8386fb1a3b165876d76057f784 Reviewed-by: Casper van Donderen <casper.vandonderen@nokia.com>
| * qdoc: Allow documenting a C++ class as a QML type.Martin Smith2012-04-0215-729/+998
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Now qdoc can handle the case where a C++ class is documented as a QML type of the same name, or as both a C++ class and a QML type of the same name. And collisions pages are created for both the HTML and the DITA XML output. A collision page is created when two items have the same name. The collision pages will be augmented later to include the list of pages where ambiguous links to one of the items listed on the collision page are actually located, so the writer can go back to those links and add the appropriate qualifier. Change-Id: I5a9632b2d2209e0784392047056bed8962005624 Reviewed-by: Martin Smith <martin.smith@nokia.com> Reviewed-by: Casper van Donderen <casper.vandonderen@nokia.com>
| * QDoc: Fix assert and remove duplicate description.Casper van Donderen2012-04-011-6/+6
| | | | | | | | | | Change-Id: Idac8488c1a2ba8cabe584244a0ea9a824a31cd65 Reviewed-by: Martin Smith <martin.smith@nokia.com>
| * QDoc: Write proper output file name for debug output.Casper van Donderen2012-03-302-2/+9
| | | | | | | | | | Change-Id: I55138c47960a4d9e1595ef648a8d0982e3bfd19b Reviewed-by: Martin Smith <martin.smith@nokia.com>
| * QDoc: Add hand-written ditamaps as children of qt.ditamapCasper van Donderen2012-03-291-30/+83
| | | | | | | | | | | | | | | | | | Known issues: the hand-written ditamap has to be a flat list. The function used should preferably become a recursive function, which would allow you to have as many nested items as you want. Change-Id: I0dc897da5222f6409e2e58c42200c342bc8cacf2 Reviewed-by: Martin Smith <martin.smith@nokia.com>
| * QDoc: Remove LOCAL LINK debug output.Casper van Donderen2012-03-291-1/+0
| | | | | | | | | | Change-Id: Iac8c5df2ca22315f34bbb738314299a23c646b2a Reviewed-by: Martin Smith <martin.smith@nokia.com>
| * QDoc: pre-/append qmlmodule/module to distinguish names.Casper van Donderen2012-03-291-0/+7
| | | | | | | | | | | | | | | | | | | | | | It is possible that a \qmlmodule and \module have the same name. This would then cause a conflict, since both of the output pages would have the same name. This change make sure that C++ modules (\module) output pages are appended with -module and that QML modules (\qmlmodule) are prepended with qmlmodule-. Change-Id: I2ce352f05ff388469fd02458354154dbf8b7b0db Reviewed-by: Martin Smith <martin.smith@nokia.com>
| * QDoc: Do not generate the sub-lists in automatic ditamap.Casper van Donderen2012-03-291-92/+0
| | | | | | | | | | Change-Id: I6f91495dabf5e4aa2d0d7c1fbc690bd1fd53bd17 Reviewed-by: Martin Smith <martin.smith@nokia.com>
| * qdoc: Add simple return types such as void to output.Casper van Donderen2012-03-281-0/+5
| | | | | | | | | | Change-Id: I2c9b2bc982f9fa3390a7b5bd322df9e015e53824 Reviewed-by: Martin Smith <martin.smith@nokia.com>
| * qdoc: Use otherprops attribute for DITA signals/slots.Casper van Donderen2012-03-281-4/+4
| | | | | | | | | | Change-Id: Id85860abfb8abdf0b7bd95a65384576d8970096b Reviewed-by: Martin Smith <martin.smith@nokia.com>
| * qdoc: also allow \page index as head of ditamap.Casper van Donderen2012-03-281-1/+1
| | | | | | | | | | | | | | | | QDoc previously only supported having \page index.html as root of the ditamap, this is hard to understand. Change-Id: I9f99bf53440aad372bb72b59e7bfa1a0427cb652 Reviewed-by: Martin Smith <martin.smith@nokia.com>
| * qdoc: Add CLI option to not generate example docs.Casper van Donderen2012-03-284-10/+19
| | | | | | | | | | Change-Id: I059ae76430adada020d338905b39ba3089c89615 Reviewed-by: Martin Smith <martin.smith@nokia.com>
| * qdoc: Rename QML classes to QML types in ditamap.Casper van Donderen2012-03-281-1/+1
| | | | | | | | | | Change-Id: I7b1a10d0d25a0a79fb018ab9138f2ef32470475d Reviewed-by: Martin Smith <martin.smith@nokia.com>
| * qdoc: Do not write index.dita multiple times in ditamap.Casper van Donderen2012-03-281-0/+9
| | | | | | | | | | Change-Id: I69719237d0ab567ce2a606c96b38f6baa2a601b5 Reviewed-by: Martin Smith <martin.smith@nokia.com>
| * qdoc: Implement \uicontrol command.Casper van Donderen2012-03-287-1/+25
| | | | | | | | | | Change-Id: I10381cd69d32352c590ec5a7d4041465af57b88b Reviewed-by: Martin Smith <martin.smith@nokia.com>
* | Remove all calls to, and deprecate qMalloc, qRealloc and qFree.Robin Burchell2012-03-311-4/+5
|/ | | | | | | | | | | | | | | | | | Callers should just call the standard allocation functions directly. Adding an extra function call onto all basic memory management for the sake of making it instrumentable in rare cases isn't really fair to everyone else. What's more, this wasn't completely reliable, as not everything was using them in a number of places. Memory management can still be overridden using tricks like LD_PRELOAD if needed. Their aligned equivilents cannot be deprecated, as no standard equivilents exist, although investigation into posix_memalign(3) is a possibility for the future. Change-Id: Ic5f74b14be33f8bc188fe7236c55e15c36a23fc7 Reviewed-by: Lars Knoll <lars.knoll@nokia.com>
* QDoc: updating manual to use "type".Jerome Pasion2012-03-214-62/+63
| | | | | | | | | -updated both QDoc manual and QDoc guide -"QML element" and "QML component" should be "QML type" Change-Id: Ib2a0e8baa9087a04d35c05bbbd35852da10faf42 Reviewed-by: Martin Smith <martin.smith@nokia.com> Reviewed-by: Casper van Donderen <casper.vandonderen@nokia.com>
* qdoc: Disable generation of .pageindex file.Casper van Donderen2012-03-212-227/+0
| | | | | | | | | | The .pageindex file was generated for the search engine on the doc.qt.nokia.com website, since this website is not used anymore there is no use for the .pageindex file. Task-number: QTBUG-24911 Change-Id: Ie74f569ce881ab383d83ac9c5a8bc223da91564a Reviewed-by: Martin Smith <martin.smith@nokia.com>
* QDoc: Changing "element" string to "type".Jerome Pasion2012-03-211-1/+1
| | | | | | | | -QDoc output should use "type", not "element". "This type was introduced..." Change-Id: I72b6ba6318889d7727796b80574b72694f2b7594 Reviewed-by: Martin Smith <martin.smith@nokia.com>
* EGLFS: Integrate building into configure.Donald Carr2012-03-211-1/+0
| | | | | | | | | | With the move to the QPA architecture EGL is now only required by individual platform plugins and the configure script has been adjusted to reflect this. Change-Id: Ieadacef0b970f29752d9e3e36a007e5cbb005b0d Reviewed-by: Oswald Buddenhagen <oswald.buddenhagen@nokia.com> Reviewed-by: Girish Ramakrishnan <girish.1.ramakrishnan@nokia.com>
* qdoc: Handle multiple \ingroup commands in QML types.Martin Smith2012-03-201-3/+7
| | | | | | | | | | | These were not handled in the QmlVisitor class. It was believed they would appear as separate commands in QmlVisitor, but the appear as one \ingroup command followed by several group identifiers. Change-Id: If198433f7cd5095264f41346987c49ee4c30a786 Reviewed-by: Casper van Donderen <casper.vandonderen@nokia.com>
* qdoc: Remove short description from apiDescMartin Smith2012-03-201-0/+12
| | | | | | | The XSLT already adds this from the <shortdesc>. Change-Id: I5813bf668f9b198e6b76bc0af8f26c7a910890fb Reviewed-by: Casper van Donderen <casper.vandonderen@nokia.com>
* qdoc: Remove the spectitle attributeMartin Smith2012-03-201-3/+3
| | | | | | | | qdoc no longer writes the title as the value of the spectitle attribute in the <apiDesc> element. Change-Id: I3f89142fa764c9ac2f3f3bcf9d9162bcf3528df2 Reviewed-by: Casper van Donderen <casper.vandonderen@nokia.com>
* qdoc: Enable XSLTs to produce correct #include info.Martin Smith2012-03-202-41/+42
| | | | | | | | | qdoc no longer writes the expected "include" statment in a codeblock in the detailed description. It writes it as an <othermeta> element in the <prolog> instead. Change-Id: I303477dbba7f2383fb374a398c890760a15744de Reviewed-by: Casper van Donderen <casper.vandonderen@nokia.com>
* qdoc: Rename qt3 support pages to Compatibility pages.Casper van Donderen2012-03-204-19/+13
| | | | | | | Task-number: QTBUG-24849 Change-Id: I9453e38372f909d75bb4fb8642dc9bd7b993aa7e Reviewed-by: Martin Smith <martin.smith@nokia.com>
* Notifier signals don't need separate documentation.Casper van Donderen2012-03-203-2/+13
| | | | | | | | | | | | | Similar to getters and setters, notifier signals don't need separate documentation. Reimplementation of http://codereview.qt-project.org/#change,19374 in qtbase. Change-Id: If77fc554a3d8c1b520940d23e17cb7f76a71660f Reviewed-by: Girish Ramakrishnan <girish.1.ramakrishnan@nokia.com> Reviewed-by: Lincoln Ramsay <lincoln.ramsay@nokia.com> Reviewed-by: Martin Smith <martin.smith@nokia.com>
* qdoc: Merge PageGenerator into Generator class.Casper van Donderen2012-03-209-1429/+1237
| | | | | | | | | | | This change also sorts all functions in Generator by alphabet and moves the implementation of the GenerateQmlInheritedBy function to the Generator class, since the implementation in both the DITA and HTML generators was the same. Task-number: QTBUG-24833 Change-Id: I44588079159e03b7ff7549e5478babb1aabdaf1b Reviewed-by: Casper van Donderen <casper.vandonderen@nokia.com>
generated by cgit v1.2.3 (git 2.25.1) at 2024-06-19 13:57:55 +0000