summaryrefslogtreecommitdiffstats
path: root/src/tools/qdoc
Commit message (Collapse)AuthorAgeFilesLines
* 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>
* 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>
* qdoc: Structure the DITA map with a root node.Martin Smith2012-03-171-2/+8
| | | | | | | | | | Use the title from the index.html page for the navtitle, if there is a title on the index.html page. Otherwise use the project as the navtitle. Task-number: Mzilla bug - 7229 Change-Id: I25fc1f09b0bdff58c6340cec7d9d8a43d95845a2 Reviewed-by: Casper van Donderen <casper.vandonderen@nokia.com>
* qdoc: Structure the DITA map with a root node.Martin Smith2012-03-154-85/+41
| | | | | | | | | | | The root topicref is now always index.dita, unless there is no index.dita. But there is always a root topicref that has the project name as its navtitle, even if there is no index.dita file to map it to. Task-number: Mzilla bug - 7229 Change-Id: I0c9fdf1a2e3ba847fe8975a0745667189a77a755 Reviewed-by: Casper van Donderen <casper.vandonderen@nokia.com>
* Rename qdoc index file to qdoc-index.htmlCasper van Donderen2012-03-151-1/+1
| | | | | Change-Id: I74fcbce7d2929c31031db379d5e0b4b0d2f48800 Reviewed-by: Martin Smith <martin.smith@nokia.com>
* Rename all occurences of qdoc3 to qdoc in the qdoc manual.Casper van Donderen2012-03-153-9/+9
| | | | | Change-Id: I84cfab5a7130aff9ed8a6eb568d78f29167e1ac8 Reviewed-by: Martin Smith <martin.smith@nokia.com>
* qdoc3: Change suffix of DITA files to .ditaMartin Smith2012-03-154-11/+13
| | | | | | | | | | The files output by the DITA XML generator now have .dita on the end instead of .xml, but the ditamap files still use .ditamap . Task-number: Mzilla bug - 7291 Change-Id: Idb8b70c5d3f2ac2c4fdf195e385393f7ac68b7ba Reviewed-by: Casper van Donderen <casper.vandonderen@nokia.com>
* bootstrap: remove QtXml dependencyGiuseppe D'Angelo2012-03-141-3/+10
| | | | | | | | | | Only qdoc is now using QtXml classes, so just add them to qdoc.pro and drop them from the bootstrap library. Change-Id: I821839396141d1d7a2ada565a513aa46c54c9620 Reviewed-by: Oswald Buddenhagen <oswald.buddenhagen@nokia.com> Reviewed-by: Lars Knoll <lars.knoll@nokia.com> Reviewed-by: Thiago Macieira <thiago.macieira@intel.com>
* qdoc3: qdoc now handles overloaded methods for QMLMartin Smith2012-03-138-15/+81
| | | | | | | | | | | | When a C++ class is documented as a QML type, it can have overloaded QML methods. These are now handled correctly by qdoc. The method list for QML types is now output with the full method signature. For signals and handlers too. Task-number: QTBUG-24670 Change-Id: If529d4136f5b480373b6ac25d2dceef15e6ea3db Reviewed-by: Casper van Donderen <casper.vandonderen@nokia.com>
* Update the footer for qdoc output for qt-project.Casper van Donderen2012-03-132-27/+31
| | | | | Change-Id: I418ac4e754aac96220d14948ce066c982c4b8054 Reviewed-by: Jerome Pasion <jerome.pasion@nokia.com>
* qdoc: Update to prepare to run on a directory.Casper van Donderen2012-03-132-22/+2
| | | | | | | | | | This change sets some default file extensions to accept to generate documentation. It also removes support for the sourceModules qdocconf variable which is not used anymore. It was used just after modularization. Change-Id: Iabdcfb534dc662bd44e0928036fd68ee4e460b07 Reviewed-by: Martin Smith <martin.smith@nokia.com>
* qdoc: Fix closing 'table class="generic"' tagSergio Ahumada2012-03-121-2/+2
| | | | | Change-Id: I251ed6d4e5788b0816211e06f33ace03d2fa14e8 Reviewed-by: Martin Smith <martin.smith@nokia.com>
* Remove unnecessary function.Casper van Donderen2012-03-121-25/+0
| | | | | | | | The reconstituteFieldMemberExpression static function was not usedf anywhere. Change-Id: Ide23045d7f7c3194a9725ae658df85562ba29ad5 Reviewed-by: Martin Smith <martin.smith@nokia.com>
* qdoc3: qdoc user manual updateMartin Smith2012-03-109-817/+1048
| | | | | | | | | Changed \bold to \b, \i to \e, and \o to \li. Task-number: QTBUG-24578 Change-Id: If02517164f30f05436596224c1b1895a86d9e9f8 Reviewed-by: Casper van Donderen <casper.vandonderen@nokia.com>
* Move qdoc into qtbase and bootstrap itLars Knoll2012-03-08134-0/+65911
We need qdoc in qtbase to be able to properly modularize our documentation and build it when building the different Qt modules. qdoc does contain a copy of the qml parser from qmldevtools, but this is the lesser evil compared to how we are currently forced to genereate our docs (and the fact that no developer can run qdoc and check the docs for their module). Change-Id: I9f748459382a11cf5d5153d1ee611d7a5d3f4ac1 Reviewed-by: Casper van Donderen <casper.vandonderen@nokia.com> Reviewed-by: Martin Smith <martin.smith@nokia.com>
generated by cgit v1.2.3 (git 2.25.1) at 2024-06-16 17:04:17 +0000