diff options
| author | Martin Smith <[email protected]> | 2015-02-13 13:00:22 +0100 |
|---|---|---|
| committer | Martin Smith <[email protected]> | 2015-02-20 11:37:18 +0000 |
| commit | 62a2f46d290c67343366cb4f707830fe7d8b3d63 (patch) | |
| tree | 4bde42e59c1d54e93fa42d2050f955782bc17ca9 /src/tools/qdoc/qmlcodeparser.cpp | |
| parent | fe7c2662b5a6a458459bf11b8d06a2b34318918d (diff) | |
qdoc: Support documentation of JavaScript
This update provides the actual support for documenting
JavaScript. It has been tested with JavaScript commands
in qdoc comments in .qdoc files but not in .js files.
Currently, we have the use case of needing to document
JavaScript using qdoc comments in .qdoc files.
For each qdoc command for QML, i.e. \qmltype, \qmlproperty,
etc, there is now a corresponding JavaScript command, i.e.
\jstype, \jsproperty, etc. Some of these might not be needed,
but they are all provided.
Briefly, document JavaScript in a .qdoc file the same way you
would document QML in a .qdoc file, but instead of using the
\qmlxxx commands, use \jsxxx commands.
Change-Id: Ib68a5f66c16472af87d9f776db162332ca13fbb7
Task-number: QTBUG-43715
Reviewed-by: Topi Reiniö <[email protected]>
Diffstat (limited to 'src/tools/qdoc/qmlcodeparser.cpp')
| -rw-r--r-- | src/tools/qdoc/qmlcodeparser.cpp | 25 |
1 files changed, 24 insertions, 1 deletions
diff --git a/src/tools/qdoc/qmlcodeparser.cpp b/src/tools/qdoc/qmlcodeparser.cpp index 6e53f88d0f0..4f5720a94d2 100644 --- a/src/tools/qdoc/qmlcodeparser.cpp +++ b/src/tools/qdoc/qmlcodeparser.cpp @@ -76,6 +76,19 @@ QT_BEGIN_NAMESPACE #define COMMAND_QMLBASICTYPE Doc::alias("qmlbasictype") #define COMMAND_QMLMODULE Doc::alias("qmlmodule") +#define COMMAND_JSTYPE Doc::alias("jstype") +#define COMMAND_JSMODULE Doc::alias("jsmodule") +#define COMMAND_JSPROPERTY Doc::alias("jsproperty") +#define COMMAND_JSPROPERTYGROUP Doc::alias("jspropertygroup") +#define COMMAND_JSATTACHEDPROPERTY Doc::alias("jsattachedproperty") +#define COMMAND_INJSMODULE Doc::alias("injsmodule") +#define COMMAND_JSSIGNAL Doc::alias("jssignal") +#define COMMAND_JSATTACHEDSIGNAL Doc::alias("jsattachedsignal") +#define COMMAND_JSMETHOD Doc::alias("jsmethod") +#define COMMAND_JSATTACHEDMETHOD Doc::alias("jsattachedmethod") +#define COMMAND_JSBASICTYPE Doc::alias("jsbasictype") +#define COMMAND_JSMODULE Doc::alias("jsmodule") + /*! Constructs the QML code parser. */ @@ -205,7 +218,16 @@ const QSet<QString>& QmlCodeParser::topicCommands() << COMMAND_QMLATTACHEDSIGNAL << COMMAND_QMLMETHOD << COMMAND_QMLATTACHEDMETHOD - << COMMAND_QMLBASICTYPE; + << COMMAND_QMLBASICTYPE + << COMMAND_JSTYPE + << COMMAND_JSPROPERTY + << COMMAND_JSPROPERTYGROUP + << COMMAND_JSATTACHEDPROPERTY + << COMMAND_JSSIGNAL + << COMMAND_JSATTACHEDSIGNAL + << COMMAND_JSMETHOD + << COMMAND_JSATTACHEDMETHOD + << COMMAND_JSBASICTYPE; } return topicCommands_; } @@ -231,6 +253,7 @@ const QSet<QString>& QmlCodeParser::otherMetaCommands() << COMMAND_SINCE << COMMAND_QMLABSTRACT << COMMAND_INQMLMODULE + << COMMAND_INJSMODULE << COMMAND_WRAPPER; } return otherMetaCommands_; |