summaryrefslogtreecommitdiff
path: root/sd/source/ui
diff options
context:
space:
mode:
authorNorah A. Abanumay <nabanimy@kacst.edu.sa>2012-08-05 13:32:31 +0300
committerPhilipp Riemer <ruderphilipp@gmail.com>2012-08-06 00:18:59 +0200
commit78b55ad11365bb97def308071bc45ca52cc557c7 (patch)
tree149d8a277593aec3c11abb99161d7c4ae399a056 /sd/source/ui
parentb80b7ba1791cdd9e79ed7a380b8981878f46b8a4 (diff)
Convert documents to follow the doxygen standard (fdo#44502, fdo#39468)
Change-Id: I58c73f74d53b5dc2eb462fb03664be65d4500170 Reviewed-by: Philipp Riemer <ruderphilipp@gmail.com>
Diffstat (limited to 'sd/source/ui')
-rw-r--r--sd/source/ui/animations/motionpathtag.hxx11
-rw-r--r--sd/source/ui/annotations/annotationtag.hxx10
-rw-r--r--sd/source/ui/presenter/CanvasUpdateRequester.hxx4
3 files changed, 9 insertions, 16 deletions
diff --git a/sd/source/ui/animations/motionpathtag.hxx b/sd/source/ui/animations/motionpathtag.hxx
index 12ff8ee46c29..867a81fab099 100644
--- a/sd/source/ui/animations/motionpathtag.hxx
+++ b/sd/source/ui/animations/motionpathtag.hxx
@@ -34,12 +34,7 @@ namespace sd {
class View;
class CustomAnimationPane;
-/*************************************************************************
-|*
-|* Basisklasse fuer alle Funktionen
-|*
-\************************************************************************/
-
+/// Base class for all functions.
class MotionPathTag : public SmartTag, public IPolyPolygonEditorController, public SfxListener, public ::com::sun::star::util::XChangesListener
{
public:
@@ -48,10 +43,10 @@ public:
SdrPathObj* getPathObj() const { return mpPathObj; }
- /** returns true if the SmartTag handled the event. */
+ /// @return true if the SmartTag handled the event.
virtual bool MouseButtonDown( const MouseEvent&, SmartHdl& );
- /** returns true if the SmartTag consumes this event. */
+ /// @return true if the SmartTag consumes this event.
virtual bool KeyInput( const KeyEvent& rKEvt );
// callbacks from sdr view
diff --git a/sd/source/ui/annotations/annotationtag.hxx b/sd/source/ui/annotations/annotationtag.hxx
index 7732467b4177..9deae0b0d0a3 100644
--- a/sd/source/ui/annotations/annotationtag.hxx
+++ b/sd/source/ui/annotations/annotationtag.hxx
@@ -39,16 +39,16 @@ public:
AnnotationTag( AnnotationManagerImpl& rManager, ::sd::View& rView, const css::uno::Reference< css::office::XAnnotation >& xAnnotation, Color& rColor, int nIndex, const Font& rFont );
virtual ~AnnotationTag();
- /** returns true if the SmartTag handled the event. */
+ /// @return true if the SmartTag handled the event.
virtual bool MouseButtonDown( const MouseEvent&, SmartHdl& );
- /** returns true if the SmartTag consumes this event. */
+ /// @return true if the SmartTag consumes this event.
virtual bool KeyInput( const KeyEvent& rKEvt );
- /** returns true if the SmartTag consumes this event. */
+ /// @return true if the SmartTag consumes this event.
virtual bool RequestHelp( const HelpEvent& rHEvt );
- /** returns true if the SmartTag consumes this event. */
+ /// @return true if the SmartTag consumes this event.
virtual bool Command( const CommandEvent& rCEvt );
// callbacks from sdr view
@@ -61,8 +61,6 @@ public:
void Move( int nDX, int nDY );
bool OnMove( const KeyEvent& rKEvt );
- // ---
-
BitmapEx CreateAnnotationBitmap(bool);
css::uno::Reference< css::office::XAnnotation > GetAnnotation() const { return mxAnnotation; }
diff --git a/sd/source/ui/presenter/CanvasUpdateRequester.hxx b/sd/source/ui/presenter/CanvasUpdateRequester.hxx
index 0800a27b6ee8..e2fe5483b49a 100644
--- a/sd/source/ui/presenter/CanvasUpdateRequester.hxx
+++ b/sd/source/ui/presenter/CanvasUpdateRequester.hxx
@@ -41,8 +41,8 @@ namespace sd { namespace presenter {
class CanvasUpdateRequester : private ::boost::noncopyable
{
public:
- /** Return the Canvas UpdateRequester object for the given shared
- canvas. A new object is created when it does not already exist.
+ /** @return the Canvas UpdateRequester object for the given shared canvas.
+ A new object is created when it does not already exist.
*/
static ::boost::shared_ptr<CanvasUpdateRequester> Instance (
const css::uno::Reference<css::rendering::XSpriteCanvas>& rxCanvas);