| Commit message (Collapse) | Author | Age | Files | Lines |
|---|
| |
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
The function pushes the file name onto the location stack so that
if an error occurs while processing the macro, the error message
can contain the correct file location for the macro in error. But
this call was pushing the location of the file containing all the
macro definitions. If there is an error processing the macro, it
should refer to the location where the macro was used, because
that's where the error is, not in the macro definition. So the
call to push() was wrong to begin with. Besides that, the push
was never popped, which led to a fatal qdoc error in macOS.
Change-Id: Ib2f74556f6a30a557e79d5c85cd12c8b3077b99a
Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
|
| |
|
|
|
|
|
|
| |
These commands are not used anywhere, and they cause
qdoc to generate illegal html code, so they are removed.
Change-Id: I39b670a9691221854a78ea5c332c67ea758199ee
Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
|
| |
|
|
|
|
|
|
|
|
| |
qdoc was not replacing qdoc macros correctly. Hopefully,
this corrects that bug. It works for the cases I tested.
I also changed the name of a class data member from "in"
to "input_" so it is easy to search for.
Change-Id: I53b8a701efa6b4113173f9d9bb7cf4ebe0a449c4
Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
|
| |
|
|
|
|
|
| |
doc.cpp:632:39: error: this statement may fall through [-Werror=implicit-fallthrough=]
Change-Id: Ia3e896da908f42939148fffd14c48709a6772552
Reviewed-by: Martin Smith <martin.smith@qt.io>
|
| |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
There were several issues with how \brief text was generated,
especially for C++ properties and variables. This commit changes
the \brief generation by:
- Preface a brief with 'This property holds ...' only if the
produced text is more or less grammatically sound.
- Eliminates 'This property holds this property holds' duplicates.
- Allow any formatting within a \brief. Previously, input like
"\brief \c true" produced no output.
The last issue is fixed also for brief attributes written to index
files, although there we cannot retain the formatting. In order to
do this, the Generator::plainCode() function was made static.
Change-Id: If5b3b7e626e87116c3d8d3c1f777d604e4647eb8
Task-number: QTBUG-58280
Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
Reviewed-by: Martin Smith <martin.smith@qt.io>
|
| |
|
|
|
|
|
|
|
|
|
|
|
| |
From Qt 5.7 -> tools & applications are licensed under GPL v3 with some
exceptions, see
http://blog.qt.io/blog/2016/01/13/new-agreement-with-the-kde-free-qt-foundation/
Updated license headers to use new GPL-EXCEPT header instead of LGPL21 one
(in those files which will be under GPL 3 with exceptions)
License header tests also updated to match current headers.
Change-Id: Ia6bdacaa3c5bbc9d31334e1a0cabfe502a484dc4
Reviewed-by: Jani Heikkinen <jani.heikkinen@qt.io>
|
| |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
This commit makes QDoc treat a string starting with '//!' as a
single-line comment that is not included in the generated HTML
output.
It has several uses: Internal documentation remarks visible only in
the source code, and a simpler alternative to \omit, \endomit commands.
Most importantly, it allows \include command to pull in content from
any file mentioned in the source directories, for example:
/*!
\fn foo()
//! [foo-descr]
...long description...
//! [foo-descr]
*/
/*/
\fn foo(int bar)
\overload foo()
\include foo.cpp foo-descr
...
*/
Above will work and the snippet identifies are omitted from the
generated HTML output.
Change-Id: I0777247dc00358682c307c356fb7d1d8a4514dac
Task-number: QTBUG-52063
Reviewed-by: Martin Smith <martin.smith@theqtcompany.com>
|
| |
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
QDoc kept track of a 'minimum indent' between code snippets seen in
the same comment block. If the first snippet had 0 indentation, all
other snippets were output with their indentation intact.
This change removes the stored minimum indent, causing the least
indented line in any <pre> block to never have leading spaces.
Has no effect on the indentation within a code snippet.
Change-Id: Ie27a4b4d370c545036dfaa573807ba9f59bbdce1
Task-number: QTBUG-49617
Reviewed-by: Martin Smith <martin.smith@theqtcompany.com>
|
| |
|
|
|
|
|
|
|
|
|
|
|
| |
When the number of parameters expected by a macro definition does not
match what's passed to the macro invocation, store the number of
parameters read so far. This prevents a crash by out-of-range
index reference.
Also, improve the documentation on macro parameters.
Change-Id: I75716f5b53f394664bb509c96aa4b53b4efba222
Task-number: QTBUG-49608
Reviewed-by: Martin Smith <martin.smith@theqtcompany.com>
|
|
|
we can do that now, as the bootstrap lib is now a properly exported
module, and qmldevtools is now bootstrapped as well.
this removes the abomination of a copy of the qml parser in qtbase.
unfortunately qtbase/2422251ee5025a067b14b989153764ab36e43f10 is
reverted, as qtdeclarative is still missing the respective change.
this introduces no regression in discoverability or usability, as a full
doc build already needed qttools - for qhelpgenerator.
Change-Id: Ic9c4c9732ddf5998637b9e42e27939ba50b31479
Reviewed-by: Jędrzej Nowacki <jedrzej.nowacki@theqtcompany.com>
Reviewed-by: Martin Smith <martin.smith@digia.com>
Reviewed-by: Lars Knoll <lars.knoll@theqtcompany.com>
Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
|
