diff options
author | Martin Smith <martin.smith@digia.com> | 2015-06-03 14:18:51 +0200 |
---|---|---|
committer | Martin Smith <martin.smith@digia.com> | 2015-06-10 12:47:02 +0000 |
commit | d884420b94abc637b2fcef6585a1fb5c93b69c2c (patch) | |
tree | bb229430f4c1ec3b986423994ca4bd04ef6e8fa4 /src/tools/qdoc/htmlgenerator.h | |
parent | 9b58fe5c264cabe6912bb4fb7b045c2aecd98cb7 (diff) |
qdoc: Improve documentation for properties
This update changes how qdoc handles getter, setter, resetter,
and notifier functions for properties. With this update, if you
provide documentation for any of these functions associated with
a property, links to that function will go to the documentation
for that function, instead of to the associated property.
Additionally, the documentation for the function will have a note
added, e.g. "Note: Notifier signal for property fubar," where the
fubar property name is a link to the documentation for property
fubar.
Change-Id: I1f821fd4a6c2de142da4718ef3bdde314dc59627
Task-number: QTBUG-45620
Reviewed-by: Venugopal Shivashankar <venugopal.shivashankar@digia.com>
Reviewed-by: Topi Reiniƶ <topi.reinio@digia.com>
Diffstat (limited to 'src/tools/qdoc/htmlgenerator.h')
-rw-r--r-- | src/tools/qdoc/htmlgenerator.h | 1 |
1 files changed, 1 insertions, 0 deletions
diff --git a/src/tools/qdoc/htmlgenerator.h b/src/tools/qdoc/htmlgenerator.h index 615de8e8a3..6a550c2b39 100644 --- a/src/tools/qdoc/htmlgenerator.h +++ b/src/tools/qdoc/htmlgenerator.h @@ -106,6 +106,7 @@ protected: void generateManifestFile(const QString &manifest, const QString &element); void readManifestMetaContent(const Config &config); void generateKeywordAnchors(const Node* node); + void generateAssociatedPropertyNotes(const FunctionNode* fn); private: enum SubTitleSize { SmallSubTitle, LargeSubTitle }; |