diff options
author | Chris Sherlock <chris.sherlock79@gmail.com> | 2014-02-04 19:55:39 +0000 |
---|---|---|
committer | Caolán McNamara <caolanm@redhat.com> | 2014-02-05 09:14:53 +0000 |
commit | 51a68b4992c6eb7015d838d1fdf9fc84ec0fa5d2 (patch) | |
tree | 3fe907e6cdefffc48000197ec7f94d9f8c104858 /include/vcl/ctrl.hxx | |
parent | 651756a5f40b6340518e97a31113cb59438ab40d (diff) |
Doxygen warnings corrected
* Doxygen spits out a lot of warnings about not being able to find
match function signatures, etc. This is because in some headers we
have a using namespace statement, in others it gets confused between
::Window and Window (!).
* Wrong use of tags:
+ Lots of @seealso - should be @see
+ Wrong usage of @overload - corrected with the right function
signature
+ HTML tags that doxygen doesn't recognize removed
Change-Id: I1c2eed941619b8764dbfcfc5ab38027518cdf261
Diffstat (limited to 'include/vcl/ctrl.hxx')
-rw-r--r-- | include/vcl/ctrl.hxx | 11 |
1 files changed, 5 insertions, 6 deletions
diff --git a/include/vcl/ctrl.hxx b/include/vcl/ctrl.hxx index 94527934ce51..f5d61246db26 100644 --- a/include/vcl/ctrl.hxx +++ b/include/vcl/ctrl.hxx @@ -105,13 +105,13 @@ public: SAL_DLLPRIVATE void ImplClearLayoutData() const; /** draws a frame around the give rectangle, onto the given device - only to be used from within the <member>Window::Draw</member> method of your sub class. + only to be used from within the Window::Draw method of your sub class. The frame is always drawn with a single line (without 3D effects). In addition, any mono color set at the control's settings is respected. Yet more additionally, if we're living in a themed desktop, this theming is ignored. - Note that this makes sense, since the *only known* clients of <member>Window::Draw</member> + Note that this makes sense, since the *only known* clients of Window::Draw are form controls, when printed or print-previewed. For form controls embedded in office documents, you don't want to have the theme look. @@ -149,9 +149,8 @@ public: Pair GetLineStartEnd( long nLine ) const; /** ToRelativeLineIndex changes a layout data index to a count relative to its line. - <p>This is equivalent to getting the line start/end pairs with - <member>GetLineStartEnd</member> until the index lies within [start,end] of a line - </p> + This is equivalent to getting the line start/end pairs with + GetLineStartEnd() until the index lies within [start,end] of a line @param nIndex the absolute index inside the display text to be changed to a relative index @@ -176,7 +175,7 @@ public: virtual Size GetOptimalSize() const; /** sets a reference device used for rendering control text - @seealso DrawControlText + @see DrawControlText */ void SetReferenceDevice( OutputDevice* _referenceDevice ); OutputDevice* GetReferenceDevice() const; |