summaryrefslogtreecommitdiffstats
path: root/src/tools/qdoc
Commit message (Collapse)AuthorAgeFilesLines
* qdoc: Snippets files no longer parsed by qdocMartin Smith2013-11-011-0/+8
| | | | | | | | | | | | | | | The files in the doc/snippets subdirectory of each example subdirectory are no longer parsed by qdoc as source files. They continue to be used as snippets files. This fix also ensures that there are no duplicates in the list of files to be parsed. Task-number: QTBUG-34003 Change-Id: Icec1a2a539237f24ee6bae89c6401f0dc81826d1 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:headers and sources paths are canonicalizedMartin Smith2013-11-011-1/+1
| | | | | | | | | | | This eliminates the possibility that the same file could appear in the file list twice causing qdoc to parse it twice. Task-number: QTBUG-34002 Change-Id: Iab63d778c9f955076515a8ae2f1bd9560099b13d 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-013-4/+16
| | | | | | | | | | | | | 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>
* Fix crash in qdoc startupKai Koehne2013-10-181-25/+23
| | | | | | | | | | | | | | the order of initialization of static variables is undefined, and we therefore cannot (safely) initialize the array with static QStrings declared elsewhere. This was leading to crashes in MinGW gcc 4.8.0. Work around the issue by initializing the array at runtime initialization instead. Task-number: QTBUG-34172 Change-Id: I24f0e6af6685fc280d12c8ef90d40b8ebe994450 Reviewed-by: Martin Smith <martin.smith@digia.com> Reviewed-by: Jędrzej Nowacki <jedrzej.nowacki@digia.com>
* Doc: Adding mark-up to boolean default values.Jerome Pasion2013-10-0816-52/+52
| | | | | | | | | | | | | | | | | Default values should have mark-up to denote that they are code. This commit changes: -"property is true" to "property is \c true". -"Returns true" to "Returns \c true". -"property is false" to "property is \c false". -"returns true" to "returns \c true". -"returns false" to "returns \c false". src/3rdparty and non-documentation instances were ignored. Task-number: QTBUG-33360 Change-Id: Ie87eaa57af947caa1230602b61c5c46292a4cf4e Reviewed-by: Oswald Buddenhagen <oswald.buddenhagen@digia.com> Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* qdoc: Remove algorithm to find common prefixMartin Smith2013-10-044-56/+30
| | | | | | | | | | | | | 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-047-34/+35
| | | | | | | | | 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: Remove debug codeTopi Reinio2013-10-021-3/+0
| | | | | | | Remove a piece a debug code from qmlvisitor.cpp Change-Id: I3a1a72d11597c36d277310c92bf9590633844d03 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>
* qdoc: Fixed handling of QML referencesMartin Smith2013-10-018-99/+133
| | | | | | | | | Updated qdoc to handle QML references without using the QML module version. Task-number: QTBUG-32173 Change-Id: Ibfba9bc92458ae04017706e904625e7d32fc0be4 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* qdoc: Correct location info for typedefs with associated enumsTopi Reinio2013-09-271-0/+6
| | | | | | | | | | | | | | For typedef nodes that have an associated enumeration, qdoc generates incorrect location info (written to index files) by simply appending '-typedef' to the node name. The correct location to link to is the associated enumeration, if one exists. Task-number: QTBUG-33684 Change-Id: I749171ccae9ccc10f084a40fda14e72d5f4d44cf Reviewed-by: Jerome Pasion <jerome.pasion@digia.com> Reviewed-by: Shawn Rutledge <shawn.rutledge@digia.com> Reviewed-by: Martin Smith <martin.smith@digia.com>
* Doc: Restore QDoc's use of the \sinceJerome Pasion2013-09-242-31/+9
| | | | | | | | | | -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-233-11/+21
| | | | | | | | | 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-219-152/+298
| | | | | | | | | | | 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>
* qdoc: Documentation for property groups is backMartin Smith2013-09-181-8/+5
| | | | | | | | | | | | | | This bug was marked fixed and closed, but I'm not sure it was ever completely fixed. The qdoc commands for QML property groups were not being processed, so although the property group and its sub-properties appeared on the page, the documentation text for the property group and its properties was never written to the HTML file. This has been corrected with this update. Task-number: QTBUG-32341 Change-Id: I5b33ab512a53456379c52236496fb7bc74850842 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* qdoc: Now reports duplicate page titles better.Martin Smith2013-09-163-7/+22
| | | | | | | | | | | | | | | | | | | Currently, qdoc reports duplicate pages, when it should be reporting duplicate page titles. Sometimes the duplicate titles actually refer to the same page, but often they are different pages with the same title. This update changes the error message to better indicate that two identical page titles were seen. A further complication was that the qdoc warnings for these duplate page title errors were useless when the duplicates were in different Qt5 modules, because the support for file location information in the qdoc index files was inadequate. This update adds better location information to each section in the index file. This makes the index files bigger and will increase qdoc runtimes, hopefully not too much. Task-number: QTBUG-33506 Change-Id: I35db3c5e1551b9ef748d63377e94453da80c1e26 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* Merge branch 'stable' into devSergio Ahumada2013-09-1318-8893/+8859
|\ | | | | | | | | | | | | | | Conflicts: src/concurrent/qtconcurrentmedian.h src/corelib/itemmodels/qabstractitemmodel.cpp Change-Id: Iac46a90bbb2958cef7670031a4b59c3becd8538a
| * Doc: split up Qdoc-manualNico Vertriest2013-09-1018-8893/+8859
| | | | | | | | | | | | | | | | | | | | | | | | | | qdoc-manual.qdoc is now an overview document Each section is a separate qdoc file Title modification in minimal qdocconf qdoc file Task-number: QTBUG-31801 Change-Id: I9e50eb8c4f1f501e9c0bc768372d4393b73053ed Reviewed-by: Topi Reiniö <topi.reinio@digia.com> Reviewed-by: Martin Smith <martin.smith@digia.com> Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* | qdoc: Eliminate duplicate page warnings in some casesMartin Smith2013-09-131-1/+15
| | | | | | | | | | | | | | | | | | Prevent qdoc from reporting duplicate pages for external pages with the same URL and title. Task-number: QTBUG-33462 Change-Id: Idabdb241aaa4fe105f7b3ea78229ff1ae8776ecf Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* | Remove qSort usages from qdocGiuseppe D'Angelo2013-09-132-2/+6
| | | | | | | | | | | | | | | | | | QtAlgorithms is getting deprecated, see http://www.mail-archive.com/development@qt-project.org/msg01603.html Change-Id: I419d767ea18944917888037899e6ececdb014e82 Reviewed-by: Martin Smith <martin.smith@digia.com> Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
* | Fix Strict Weak Ordering in qdoc's comparatorGiuseppe D'Angelo2013-09-131-1/+1
| | | | | | | | | | | | | | | | | | If both n1 and n2 are "Private", the comment says they're equivalent, but the function is actually stating that n1 < n2 AND n2 < n1. Change-Id: I8e30b32c1e5240551ab1808baf6fc476841dfde4 Reviewed-by: Martin Smith <martin.smith@digia.com> Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
* | QDoc: properly initialize a memberGiuseppe D'Angelo2013-09-131-1/+3
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Spotted by valgrind: ==14189== Conditional jump or move depends on uninitialised value(s) ==14189== at 0x47B3FD: DocParser::parse(QString const&, DocPrivate*, QSet<QString> const&, QSet<QString> const&) (doc.cpp:1627) ==14189== by 0x4818AC: Doc::Doc(Location const&, Location const&, QString const&, QSet<QString> const&, QSet<QString> const&) (doc.cpp:2755) ==14189== by 0x4E6C3D: PureDocParser::processQdocComments() (puredocparser.cpp:140) ==14189== by 0x4E6A9E: PureDocParser::parseSourceFile(Location const&, QString const&) (puredocparser.cpp:109) ==14189== by 0x4D2E4C: processQdocconfFile(QString const&) (main.cpp:473) ==14189== by 0x4D3B3C: main (main.cpp:656) ==14189== Uninitialised value was created by a heap allocation ==14189== at 0x4C2B1C7: operator new(unsigned long) (in /usr/lib/valgrind/vgpreload_memcheck-amd64-linux.so) ==14189== by 0x474378: DocPrivate::constructExtra() (doc.cpp:415) ==14189== by 0x47B975: DocParser::insertTarget(QString const&, bool) (doc.cpp:1676) ==14189== by 0x476B52: DocParser::parse(QString const&, DocPrivate*, QSet<QString> const&, QSet<QString> const&) (doc.cpp:956) ==14189== by 0x4818AC: Doc::Doc(Location const&, Location const&, QString const&, QSet<QString> const&, QSet<QString> const&) (doc.cpp:2755) ==14189== by 0x4E6C3D: PureDocParser::processQdocComments() (puredocparser.cpp:140) ==14189== by 0x4E6A9E: PureDocParser::parseSourceFile(Location const&, QString const&) (puredocparser.cpp:109) ==14189== by 0x4D2E4C: processQdocconfFile(QString const&) (main.cpp:473) ==14189== by 0x4D3B3C: main (main.cpp:656) Change-Id: I5c50c6611a1d901cc19d12bc3757977c36b2a73b Reviewed-by: Martin Smith <martin.smith@digia.com> Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
* | qdoc: Avoid CppCodeMarker crash on abstract QML typesMartin Smith2013-09-121-1/+7
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | In a while loop, when the first QML type encountered was abstract, qdoc didn't create a class map on the heap, but later in the loop, the class map was used anyway. This caused a crash because of a null pointer to the class map. Now qdoc creates a class map if one hasn't been created yet, even if the QML type is abstract. This might not be correct, but the real problem is probably the order in which qdoc processes the QML types. It should probably always start with a non-abstract type. But this fix will at least avoid the crash. Task-number: QTBUG-33387 Change-Id: Icecb165261469856820f81e3866218b15416ae3b Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* | Merge "Merge remote-tracking branch 'origin/stable' into dev" into ↵Sergio Ahumada2013-09-101-3/+8
|\ \ | | | | | | | | | refs/staging/dev
| * | Merge remote-tracking branch 'origin/stable' into devSergio Ahumada2013-09-071-3/+8
| |\| | | | | | | | | | Change-Id: I9ee4176f0a0078908d49896508826154c9f71530
| | * 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>
* | | qdoc: Better use of versions of QML modulesMartin Smith2013-09-103-36/+44
|/ / | | | | | | | | | | | | | | | | | | | | | | | | | | Now qdoc doesn't use the QML module version number when it isn't necessary. Page names are cleaner without appending the version number to the QML module name. Also reduces the number of duplicate page warnings, but this will be updated further next time. Task-number: QTBUG-33257 Change-Id: Iba587164532bdc819523e0666f7561ac2dbd5e52 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* | qdoc: Removed declared but undefined member functionMartin Smith2013-09-051-1/+0
| | | | | | | | | | | | | | | | | | The declaration for addToQmlModule() in class Tree is removed. Task-number: QTBUG-33350 Change-Id: I2278a67cd6daf0e7723b4bf6d33ff9ed33cf9266 Reviewed-by: Jerome Pasion <jerome.pasion@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>
* | Merge "Merge remote-tracking branch 'origin/stable' into dev" into ↵Sergio Ahumada2013-09-022-0/+104
|\ \ | | | | | | | | | refs/staging/dev
| * | Merge remote-tracking branch 'origin/stable' into devFrederik Gladhorn2013-08-272-0/+104
| |\| | | | | | | | | | | | | | | | | | | Conflicts: examples/widgets/doc/src/addressbook-fr.qdoc Change-Id: Id1196e8e0c6445f1616c3f29234c974d809f8e48
| | * 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>
* | | QDoc: Fix (!a == b) bugTobias Hunger2013-09-022-2/+2
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This is (!a) == b which is not what is intended here. This exact bug was fixed in a couple of other instances of the QmlJSParser (in QtCreator and Qt itself) by now. Change-Id: I46a50153d7c349f21e0a888e2e3b4c4fa65c27c0 Reviewed-by: Lars Knoll <lars.knoll@digia.com>
* | | qdoc: Enable support for rvalue references in function signaturesTopi Reinio2013-08-301-1/+5
|/ / | | | | | | | | | | | | | | | | | | | | | | | | | | | | qdoc interprets the double-ampersand in function parameters using rvalue references (e.g. 'Type &&other') incorrectly as a logical AND operator, resulting in a syntax error. This change works around the issue by treating '&' the same as '*', and defining Q_COMPILER_RVALUE_REFS for qdoc. Task-number: QTBUG-32675 Change-Id: I499611f16f22c33ff5b878da0cd59d67ddf53d72 Reviewed-by: Giuseppe D'Angelo <giuseppe.dangelo@kdab.com> Reviewed-by: Jerome Pasion <jerome.pasion@digia.com> Reviewed-by: Martin Smith <martin.smith@digia.com>
* | qdoc: Fixed the relative link to installdir problemMartin Smith2013-08-261-1/+2
| | | | | | | | | | | | | | | | | | | | | | Instead of using the fake "outputdir" to force qdoc to generate a relative path to the actual output dir, it now uses the value of HTML.outputsubdir, or just "html" if HTML.outputsubdir is not specified. Task-number: QTBUG-32580 Change-Id: I45c79a788e102213e6d343a7ed108a3d17d94759 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* | qdoc: Fix the qdoc \include commandMartin Smith2013-08-224-4/+44
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | qdoc's \include command now works as expected. This command is only for including a file that contains qdoc comments that contain qdoc commands to be processed by qdoc. The file to be included should have the .qdocinc suffix, although qdoc will accept any suffix now. The file must be in one of the directories specified by the sourcedirs variable in the qdocconf file. Task-number: QTBUG-33046 Change-Id: I45ea08932b4218aae369469968117fb5132f764b Reviewed-by: Alex Blasche <alexander.blasche@digia.com> Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* | qdoc: Make example file names uniqueMartin Smith2013-08-223-1/+10
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | To avoid duplicate files for examples, the files are named this way. Suppose you have an example called mandelbrot. The example is in a subdirectory named mandelbrot, and there is a \example command somewhere like this: \example mandelbrot In this case, the mandelbrot example is in the QtCore module. Then the name of the example page will be: "qtcore-mandelbrot-example" ...and the names of the example files will be: "qtcore-mandelbrot-main-cpp.html" "qtcore-mandelbrot-mandelbrot-pro.html" "qtcore-mandelbrot-mandelbrotwidget-cpp.html" "qtcore-mandelbrot-mandelbrotwidget-h.html" "qtcore-mandelbrot-renderthread-cpp.html" "qtcore-mandelbrot-renderthread-h.html" Task-number: QTBUG-32580 Change-Id: Ic4445fd65b679523d6d94a8b0c19289d049ef0b0 Reviewed-by: Martin Smith <martin.smith@digia.com> Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* | Merge remote-tracking branch 'origin/stable' into devFrederik Gladhorn2013-08-211-0/+292
|\| | | | | | | | | | | | | | | | | Conflicts: qmake/doc/src/qmake-manual.qdoc src/plugins/platforms/xcb/qxcbconnection_xi2.cpp src/src.pro Change-Id: I0a560826c420e46988da3776bd8f9160c365459a
| * 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>
* | Merge remote-tracking branch 'origin/stable' into devFrederik Gladhorn2013-08-142-323/+376
|\| | | | | | | | | | | | | | | | | | | | | | | | | Conflicts: configure mkspecs/macx-xcode/Info.plist.app mkspecs/macx-xcode/Info.plist.lib qmake/doc/qmake.qdocconf src/corelib/global/qglobal.h tests/auto/other/exceptionsafety/exceptionsafety.pro tests/auto/widgets/widgets/qcombobox/tst_qcombobox.cpp Change-Id: I3c769a4a82dc2e99a12c69123fbf17613fd2ac2a
| * 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>
* | qdoc: Let default output subdir be htmlMartin Smith2013-08-122-1/+6
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | When you want qdoc to output the docs in a single output subdirectory, you would add these lines to your qdocconf file: HTML.nosubdirs = "true" HTML.outputsubdir = "html" The name of the output subdir can be anything. But if you leave out the second line, qdoc now defaults to using "html" as the single output subdir. Task-number: QTBUG-32580 Change-Id: Ibfb2a0c578515ef934e816b2d7a516b64f0f9dcf Reviewed-by: Jerome Pasion <jerome.pasion@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-0810-41/+78
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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-024-7/+36
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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>
* | qdoc: Ensure obsolete members file is writtenMartin Smith2013-07-311-0/+7
| | | | | | | | | | | | | | | | | | | | | | In the case where the only obsolete members of a class were actually non-members but just related functions, the help file writer didn't include a reference to the obsolete members file. This update fixes that bug. Task-number: QTBUG-31379 Change-Id: I065da649bc12e3dcc81244939be0162599d54be9 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
generated by cgit v1.2.3 (git 2.25.1) at 2024-06-04 21:35:18 +0000