summaryrefslogtreecommitdiffstats
path: root/src/tools/qdoc
Commit message (Collapse)AuthorAgeFilesLines
* Fix warning about unused variable in qdocThiago Macieira2012-12-231-1/+1
| | | | | | | codeparser.cpp:245:18: error: unused variable ‘dn’ [-Werror=unused-variable] Change-Id: Id271b3829ba3278e80d4e79746db7aabfabd751a Reviewed-by: Olivier Goffart <ogoffart@woboq.com>
* QDoc: Fix warning - unused variableFrederik Gladhorn2012-12-191-1/+1
| | | | | Change-Id: Id4068e1a1fcfad8fb3cc9174f995cb2b73b6e194 Reviewed-by: Martin Smith <martin.smith@digia.com>
* remove obsolete DEPENDPATH assignmentsOswald Buddenhagen2012-12-171-3/+0
| | | | | | | | qmake now add CONFIG+=depend_includepath by default, making manual DEPENDPATH setup unnecessary. Change-Id: Ie57cf05c369e21b5b9e099b6ce9be4f75da1508f Reviewed-by: Joerg Bornemann <joerg.bornemann@digia.com>
* Clean up Q_WS_WINDebao Zhang2012-12-141-5/+0
| | | | | | | | | | | | The first branch is required to MSVC. The bitfield isn't large enough to represent all possible enum values of Virtualness for MSVC. In addition, using bitfield is a premature optimisation in this case. So remove them. Change-Id: I4c5f85271d2bca1411426e6a321a795a7e783aff Reviewed-by: Thiago Macieira <thiago.macieira@intel.com> Reviewed-by: Friedemann Kleint <Friedemann.Kleint@digia.com>
* qdoc: Make links to \target work intermoduleMartin Smith2012-12-124-34/+41
| | | | | | | | | | | | | | \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: Fix generated anchors for c++ class signalsTopi Reinio2012-12-111-1/+1
| | | | | | | | | | Add a missing 's' for plural form for signals. This fixes the linking to Signals topic in class references. Task-number: QTBUG-28450 Change-Id: Ic666e608b4b5b40b1f886ea581e54227e1a94678 Reviewed-by: Martin Smith <martin.smith@digia.com> Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* qdoc: Make extraimages behave like styles and scriptsMartin Smith2012-12-051-3/+3
| | | | | | | | | | This configuration variable now assumes its values, if relative, are relative to the config file that contains the extraimages variable. Task-number: QTBUG-28307 Change-Id: I9b34d1f456b31e36ac77401b957b68cd10590376 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* qdoc: Don't include inherited members in the class refMartin Smith2012-12-054-78/+96
| | | | | | | | | | | | | | | | | | | | | | | | Once upon a time, the inherited functions, signals, slots, etc were not listed on the class reference page, but they were counted and a link to the base class was provided for them, eg: 2 public functions inherited from QAbstractListModel 39 public functions inherited from QAbstractItemModel 31 public functions inherited from QObject Somehow, this got broken, so that all these inherited things were listed on the class reference page as if they were members of the class. But they liunked to the documentation in the base class. This now works correctly again. It simnplifies the class reference pages a lot. Task-number: QTBUG-27496 Change-Id: If493da8cbf81634f1344b12094d9a06f8528e8e5 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com> Reviewed-by: Lars Knoll <lars.knoll@digia.com>
* Remove reference to Qt 3 documentation from example qdoc code.hjk2012-11-301-3/+1
| | | | | Change-Id: I0999b24f12ee4c878fc2a95b171474eea7a55ba5 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* More changes from Nokia to DigiaSergio Ahumada2012-11-302-4/+4
| | | | | | Change-Id: I8f2edd238e64c01d3ccb7c012b389d61435d7135 Reviewed-by: Lars Knoll <lars.knoll@digia.com> Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* qdoc: Don't include internal items in annotated listsMartin Smith2012-11-292-2/+19
| | | | | | | | | 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>
* qdoc: Listing QML group members across modulesMartin Smith2012-11-282-5/+13
| | | | | | | | | | | | | This is a second update, which fixes the "All QML APIs by Module" page, I think. I expect there will be more insifious places where this problem will pop up. qdoc must be dragged, kicking and screaming into the modular age. Task-number: QTBUG-28036 Change-Id: I8dd4733a2b0aac9bab3cb2066b6dbf139a8e98a6 Reviewed-by: Lars Knoll <lars.knoll@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-2716-417/+395
| | | | | | | | | | | | | | 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-266-6/+6
| | | | | 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-263-4/+8
| | | | | | | | | | | | | | | | | | | | | | | | 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>
* qdoc: fix urls in manifests after modularizationhjk2012-11-231-1/+1
| | | | | Change-Id: Ib01062f29139f670894f5496d67ccdfe622b778b Reviewed-by: Martin Smith <martin.smith@digia.com>
* qdoc: Make image paths relative to html fileMartin Smith2012-11-211-4/+5
| | | | | | | Task-number: QTBUG-28080 Change-Id: Ie552cacdf736f9f6da3148a11ef2362248775e1a Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* Merge branch 'newdocs'Eskil Abrahamsen Blomfeldt2012-11-2019-275/+501
|\ | | | | | | | | | | | | | | | | | | | | Added prepare_docs to qt_build_config.prf (it was added directly in configure in the source branch) Conflicts: configure tools/configure/configureapp.cpp Change-Id: I1337c69fc62b1c934e3e39b4409e4857440c9db8
| * qdoc: Handle extra imahes exactly like stylesMartin Smith2012-11-161-18/+7
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The values of the extraimages variable in the qdocconf file must now be paths that are relative to the location of the qdocconf file, just like for styles. They can be absolute paths, of course, but if they are relative, they must be relative to the qdocconf file containing the extraimages variable. The extraimages variable is for including images used in the HTML heard and footer that are not referred to in the documentation. Task-number: QTBUG-27878 Change-Id: If5e0d1dee7ba231a9c1a73f02a1bbaeb7bfe52c8 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
| * qdoc: Handle scripts exactly like stylesMartin Smith2012-11-161-15/+3
| | | | | | | | | | | | | | | | | | | | | | | | | | The values of the scripts variable in the qdocconf file must now be paths that are relative to the location of the qdocconf file, just like for styles. They can be absolute paths, of course, but if they are relative, they must be relative to the qdocconf file containing the scripts variable. Task-number: QTBUG-27878 Change-Id: Iec12d1937ca9db540a2aa5e378fadc60de0a2d8c Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
| * qdoc: Removed debug codeMartin Smith2012-11-163-13/+0
| | | | | | | | | | | | | | | | Just removing calls to qDebug(). Task-number: QTBUG-27878 Change-Id: I592ddbb8541b5b65aee9e0f940b50217e84b3a5e Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
| * qdoc: better copying of .css filesMartin Smith2012-11-166-85/+196
| | | | | | | | | | | | | | | | | | | | | | This change ignores templatedir for css files. It assumes that the paths in the stylesheets variable are relative to the qdocconf file that contains the stylesheets variable. Task-number: QTBUG-27878 Change-Id: I2155e58f352e17d710c93ad4e92679beb169d823 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
| * qdoc: better copying of .css filesMartin Smith2012-11-144-9/+27
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This fix searches for the css files specified in the stylesheets variable. It searches for them in the directory specified as the templatedir. It copies them into the style subdirectory of the outputdir. It also tests QT_INSTALL_DOCS before setting it to the library info. If it was set on the command line, it is not set from the library info. This change also includes some debug code, which will be removed after testing. Task-number: QTBUG-27878 Change-Id: I7a9469b840e13b966aca44b99aebba102e5d4f0c Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
| * qdoc: better copying of .css filesMartin Smith2012-11-081-46/+40
| | | | | | | | | | | | | | | | | | | | | | This fix searches for the css files specified in the stylesheets variable. It searches for them in the directory specified as the templatedir. It copies them into the style subdirectory of the outputdir. Task-number: QTBUG-27878 Change-Id: Ic9ff43ab6f939cb50f1b41a9cc58f3f8686ebaf5 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
| * qdoc: Removed setting of codeindent variableMartin Smith2012-11-072-3/+6
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | All the qdocconf files in use for Qt 5.0 set the codeindent variable to 1, which prefixes each line of a snippet with one ' '. But this messes up the cutting and pasting of snippets into editors for actual use. qdoc now lets the codeindent variable be initialized to 0, and then it never changes it. This looks ok in the default formatted html output. If the html output formatted with the template CSS files also looks ok, then the codeindent variable can be removed from all the qdocconf files, since it will no longer be used by qdoc. Task number: QTBUG-27798 Change-Id: I398c57bdfc99e747ec086fbd8ddf5994cf3ee6d5 Reviewed-by: Mitch Curtis <mitch.curtis@digia.com> Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
| * Help generator: Add a global config for "extraFiles".Jerome Pasion2012-11-071-0/+1
| | | | | | | | | | | | | | | | There should be a way to include files across projects regardless of their project configuration. Change-Id: I61797fad594c425a30a54b73539ae670e9545cb9 Reviewed-by: Martin Smith <martin.smith@digia.com>
| * qdoc: Added module attribute to most index elementsMartin Smith2012-11-067-10/+100
| | | | | | | | | | | | | | | | | | | | | | | | | | | | The index file generated by qdoc when it is run in -prepare mode has been modified so that most elements have a module attribute. The value of the module attribute either came from an \inmodule command, or it is the value of the project variable specified in the qdocconf file that was read by qdoc. Task number: QTBUG-27626 Change-Id: I44198bbbc1738fafc110c6b905eb1d67bc745323 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
| * qdoc: Fixed the since list for modularized QtMartin Smith2012-11-024-26/+24
| | | | | | | | | | | | | | | | | | This required adding a "since" attribute to the index file. Task number: QTBUG-27695 Change-Id: I97ca96b837ce404ea85ca8086718be4e7a9e21a8 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
| * qdoc: Fixed All Namespaces listMartin Smith2012-10-311-1/+1
| | | | | | | | | | | | | | | | | | | | | | In Qt5, each namespace has a URL, so the test for an empty URL fails in findAllNamespaces(). The test is now wrong and is therefore removed. Task number: QTBUG-27695 Change-Id: I888f70aff6e6e6c696e173caa91b5dcfabdab0ec Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
| * qdoc: Fixed All Functions listMartin Smith2012-10-301-1/+1
| | | | | | | | | | | | | | | | | | | | | | In Qt5, each class has a URL, so the test for an empty URL fails in findAllFunctions(). The test is now wrong and is therefore removed. Task number: QTBUG-27695 Change-Id: If1aa823d4c59b91c67113f77a1a57c04ff7d1a02 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
| * qdoc: Fixed All Classes listMartin Smith2012-10-261-1/+1
| | | | | | | | | | | | | | | | | | | | | | In Qt5, each class has a URL, so the test for an empty URL fails in findAllClasses(). The test is no longer necessary and is removed. Task number: QTBUG-27695 Change-Id: Id3e7b17c9d68fc59340f88d1300f2a422ad2a18c Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
| * qdoc: Adding the -log-progress optionMartin Smith2012-10-254-8/+18
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | qdoc now sends progress log messages to stderr only if -log-progress appears on the command line. The progress messages are not printed to stderr if -log-progress is not used. i.e., -log-progress is off by default. Task number: QTBUG-27707 Change-Id: Id605d943506ab38639730bf16473b156d061dc53 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com> Reviewed-by: Jędrzej Nowacki <jedrzej.nowacki@digia.com> Reviewed-by: Martin Smith <martin.smith@digia.com>
| * qdoc: Don't load index in -prepare phaseMartin Smith2012-10-254-92/+122
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | qdoc was loading index files during the -prepare phase, which it shouldn't do. The index files it was loading were from modules other than the one qdoc was running on. They had not been deleted because qdoc only clears the output directory of the module it is running on. Also added a static function to the Location class to print information messages on standard error. This is useful to see what qdoc is doing and when it is doing it because these log messages are interleaved in the qdoc error messages. More of these log messages will be added as needed. Also removed some unneeded qDebug() stuff in the code that processes the dependencies from the qdocconf file. Task number: QTBUG-27707 Change-Id: I1eec8d6ec89ff040969c2a1f62f21f551f347e05 Reviewed-by: Tor Arne Vestbø <tor.arne.vestbo@digia.com>
| * qdoc: Clear outputdir in -prepare phase onlyMartin Smith2012-10-232-16/+23
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | qdoc now clears the outputdir in the -prepare phase but not in the -generate phase. It also does not print error and warning messages in the -prepare phase. It does print fatal errors in the -prepare phase, of course, and the QML parser prints syntax errors in the -prepare phase, but all the qdoc errors and warnings are only printed in the -generate phase. Task number: QTBUG-27688 Change-Id: I9973a473260b4f79428f6b8e12a5ac35f3be15b4 Reviewed-by: Tor Arne Vestbø <tor.arne.vestbo@digia.com>
* | make qt_tool support building bootstrapped toolsOswald Buddenhagen2012-11-161-7/+1
| | | | | | | | | | | | | | | | | | | | as a "side effect", this fixes the build of bootstrapped tools when doing a debug build under msvc: qt.prf would add CONFIG+=release after default_post.prf already loaded debug.prf. Change-Id: Idd17cf28d358950fd90bb18ca7a8d67e06953bc1 Reviewed-by: Joerg Bornemann <joerg.bornemann@digia.com> Reviewed-by: Jan Arve Sæther <jan-arve.saether@digia.com>
* | remove pointless TARGET assignmentsOswald Buddenhagen2012-11-161-1/+0
| | | | | | | | | | | | | | TARGET defaults to the project file's basename Change-Id: I0cd204ae6559e6c51d3c987bc38ae372e2b4a3dd Reviewed-by: Joerg Bornemann <joerg.bornemann@digia.com>
* | add (parts of) QtXml to the bootstrap libOswald Buddenhagen2012-11-081-9/+3
| | | | | | | | | | | | | | | | we bootstrap it anyway (as qdoc already needed it). now lrelease will also need it. Change-Id: I5117634448368e18d6cf5540d678e039a66c7260 Reviewed-by: Joerg Bornemann <joerg.bornemann@digia.com>
* | compile bootstrap lib with QT_NO_TRANSLATIONOswald Buddenhagen2012-11-081-2/+0
| | | | | | | | | | Change-Id: Ie0d65d69dd924f0815e1214adc4598e0e1b3b8f4 Reviewed-by: Joerg Bornemann <joerg.bornemann@digia.com>
* | Generate a proper static QtBootstrap moduleOswald Buddenhagen2012-11-081-2/+1
|/ | | | | | | | | | | Making a properly installed libQtBootstrap simplifies our tools build process a little and in addition allows other comand line tools to use the bootstrap lib and link against it. Initial-version-by: Lars Knoll Change-Id: Iddf4568a5505bc24898ec1abf7e7022e19f0a454 Reviewed-by: Joerg Bornemann <joerg.bornemann@digia.com>
* qdoc outputs warnings in a form which Creator will recognizeShawn Rutledge2012-10-131-2/+3
| | | | | | | | | | | Recently Creator started recognzing the warnings from qdoc, however because warnings are not labeleled with " warning: ", there is no yellow-triangle symbol in the Issues list. This patch makes the output look the same as warnings or errors that come from gcc. Change-Id: I895a656d22ce8b59da90c58b86a444c86c8edf84 Reviewed-by: Martin Smith <martin.smith@digia.com> Reviewed-by: Frederik Gladhorn <frederik.gladhorn@digia.com>
* qdoc: qdoc now can run in 2 passesMartin Smith2012-10-135-26/+56
| | | | | | | | | | | | | | | | | | | | Two command line options have been added, -prepare and -generate. If you run qdoc with -prepare, qdoc reads and parses the source files but does not generate the documentation. It only creates the .index file for the module you are running qdoc on. If you run qdoc with -generate, qdoc reads and parses the source files as well as the .index files created by running qdoc with -prepare, and it generates the documentation but no .index file. If you run without either option, qdoc runs as before, i.e. it runs both passes as a single pass. Task number: QTBUG-27539 Change-Id: Idbfe3f0f9dff58283596b504f00dff3f70f6e371 Reviewed-by: Tor Arne Vestbø <tor.arne.vestbo@digia.com> Reviewed-by: Martin Smith <martin.smith@digia.com>
* qdoc: Allow empty character literal ''Martin Smith2012-10-131-2/+8
| | | | | | | | | | | qdoc's tokenizer was reporting an error for the empty character literal ''. Now it allows it. Apparently it makes sense in .js files. Task number: QTBUG-25775 Change-Id: If407427fad9b65a035c2c4785d53c9e3d5202e62 Reviewed-by: Martin Smith <martin.smith@digia.com>
* Modularize documenation buildTor Arne Vestbø2012-10-102-1/+12
| | | | | | | | | | qdocconf files can now reference $QT_INSTALL_DOCS to pick up e.g. global includes, instead of using relative paths. Qt modules will automatically get a doc target that builds and installs into the right place (including supporting shadow-builds) if they set QMAKE_DOCS before loading(qt_module). Change-Id: Ia408385199e56e3ead0afa45645a059d1a8b0d48 Reviewed-by: Tor Arne Vestbø <tor.arne.vestbo@digia.com>
* Centralize place where we ensure qdoc is built before generating docsTor Arne Vestbø2012-10-101-5/+0
| | | | | Change-Id: Ie0220d3c76990f6052edcd8c738e4e2807f35c71 Reviewed-by: Tor Arne Vestbø <tor.arne.vestbo@digia.com>
* qdoc: Implements the -no-link-errors optionMartin Smith2012-10-108-50/+36
| | | | | | | | | | | | The -no-link-errors flag tells qdoc not to print any link error messages at all. This is useful for finding and fixing all non-link errors in a module. Task number: QTBUG-26870 Change-Id: Id4b0eebb6c0509c57d2f01763b6dedbfb6756a91 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com> Reviewed-by: Martin Smith <martin.smith@digia.com>
* doc: remove old un-used monolithic qdocconf fileTor Arne Vestbø2012-10-081-115/+0
| | | | | Change-Id: I253fa079928e55e2c3c574e9c98780d2c72086cf Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* Fix a bug in how paths are made canonical and relativeJan Arve Saether2012-10-081-1/+1
| | | | | Change-Id: Id9b2de9097cab4520882b48a28fccd382c5e076d Reviewed-by: Martin Smith <martin.smith@digia.com>
* qdoc: Simplification of target ref constructionMartin Smith2012-10-086-171/+188
| | | | | | | | | | | | This change is being done to simplify qdoc, but the motivation was to fix a segfault in qdoc when running the release version of qdoc on linux. The change improves qdoc by simplifying the code whether it fixes the segfault or not. Change-Id: I2c865f7f1e2a44763aa7349d1bd739ad562f4029 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* qdoc: Change to debug outputMartin Smith2012-10-081-1/+2
| | | | | | | | Only print debug output if -debug is used on the command line. Change-Id: I2bdfca1a072f728427da61f05b34e6e07d933183 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
generated by cgit v1.2.3 (git 2.25.1) at 2024-04-26 05:17:22 +0000