diff options
author | Leena Miettinen <riitta-leena.miettinen@digia.com> | 2013-09-06 16:48:12 +0200 |
---|---|---|
committer | Erik Verbruggen <erik.verbruggen@digia.com> | 2013-09-09 11:24:23 +0200 |
commit | 83aad38cf69c0796e6de50f623829c2fac55b526 (patch) | |
tree | a95d9f2be63a0eeb6b55a16a0699aeb4d104f11b /src/plugins/cpptools/cpppointerdeclarationformatter.h | |
parent | 8ac12a7495a3f7fef7bc151e470cda9a35535124 (diff) | |
download | qt-creator-83aad38cf69c0796e6de50f623829c2fac55b526.tar.gz |
Doc: edit cpptools docs
Remove \briefs from function descriptions and use standard
wording in them.
Use standard wording for \enum.
Replace \param with \a.
Change-Id: If429b6fc67ef6d1313c18f6111aa84f9c996189f
Reviewed-by: Erik Verbruggen <erik.verbruggen@digia.com>
Diffstat (limited to 'src/plugins/cpptools/cpppointerdeclarationformatter.h')
-rw-r--r-- | src/plugins/cpptools/cpppointerdeclarationformatter.h | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/src/plugins/cpptools/cpppointerdeclarationformatter.h b/src/plugins/cpptools/cpppointerdeclarationformatter.h index 621c6d3971..9eadd6ed26 100644 --- a/src/plugins/cpptools/cpppointerdeclarationformatter.h +++ b/src/plugins/cpptools/cpppointerdeclarationformatter.h @@ -63,10 +63,10 @@ public: /*! \enum PointerDeclarationFormatter::CursorHandling - This simplifies the QuickFix implementation. + This enum type simplifies the QuickFix implementation. \value RespectCursor - Consider the cursor position / selection of the CppRefactoringFile + Consider the cursor position or selection of the CppRefactoringFile for rejecting edit operation candidates for the resulting ChangeSet. If there is a selection, the range of the edit operation candidate should be inside the selection. If there is no selection, the cursor |