Details
-
User Story
-
Resolution: Fixed
-
P3: Somewhat important
-
5.3.0 Alpha, 5.14.1
-
None
-
13
-
DaVinci sprint 3, DaVinci sprint 4, DaVinci sprint 5
-
e18472fdd03a1a0633aa153ba8e579be4869fcf3
Description
The QML Documentation Style page (http://qt-project.org/wiki/QMLDocumentationStyle ) says, "Signal documentation must... mention the corresponding signal handler", and gives this example:
/* This signal is emitted when the user clicks the button. A click is defined as a press followed by a release. The corresponding handler is \c onClicked. */
This is a good candidate for automatic text generation. Rather than ask developers to write it out manually (which takes extra effort and might be overlooked/wrongly-written), QDoc can append "The corresponding handler is \c on<CapitalizedSignalName>." as a standalone paragraph to the documentation.
Tasks
- Add this feature to QDoc (including necessary refactoring as required)
- Remove the lines that have already been added manually
- Update tests
- Update the wiki page; no longer ask developers to mention the handler names