From 5569a65ea4984f72212a44679f2125843a855a80 Mon Sep 17 00:00:00 2001 From: Chris Sherlock Date: Thu, 4 Feb 2016 17:36:41 +1100 Subject: accessibility: cleanup doxygen errors Change-Id: I6abc6e84edc461e8fa20f9c9689e0a66e26980af --- .../extended/AccessibleBrowseBoxBase.hxx | 2 +- .../extended/AccessibleBrowseBoxTable.hxx | 21 ++++++-------- .../extended/AccessibleBrowseBoxTableBase.hxx | 26 ++++++++--------- .../extended/AccessibleGridControlBase.hxx | 33 +++++++++------------- .../extended/AccessibleGridControlHeader.hxx | 22 +++++++-------- .../extended/AccessibleGridControlTable.hxx | 24 ++++++++-------- 6 files changed, 60 insertions(+), 68 deletions(-) (limited to 'accessibility') diff --git a/accessibility/inc/accessibility/extended/AccessibleBrowseBoxBase.hxx b/accessibility/inc/accessibility/extended/AccessibleBrowseBoxBase.hxx index 66b49a84e209..fe3006503d04 100644 --- a/accessibility/inc/accessibility/extended/AccessibleBrowseBoxBase.hxx +++ b/accessibility/inc/accessibility/extended/AccessibleBrowseBoxBase.hxx @@ -73,7 +73,7 @@ typedef ::cppu::WeakAggComponentImplHelper5< /** The BrowseBox accessible objects inherit from this base class. It implements basic functionality for various Accessibility interfaces and - the event broadcaster and contains the ::osl::Mutex. */ + the event broadcaster and contains the osl::Mutex. */ class AccessibleBrowseBoxBase : public ::comphelper::OBaseMutex, public AccessibleBrowseBoxImplHelper diff --git a/accessibility/inc/accessibility/extended/AccessibleBrowseBoxTable.hxx b/accessibility/inc/accessibility/extended/AccessibleBrowseBoxTable.hxx index b9a3fcc8878e..df52d7bb1156 100644 --- a/accessibility/inc/accessibility/extended/AccessibleBrowseBoxTable.hxx +++ b/accessibility/inc/accessibility/extended/AccessibleBrowseBoxTable.hxx @@ -24,11 +24,8 @@ #include "accessibility/extended/AccessibleBrowseBoxTableBase.hxx" - namespace accessibility { - - /** This class represents the accessible object of the data table of a BrowseBox control. */ class AccessibleBrowseBoxTable : public AccessibleBrowseBoxTableBase @@ -44,7 +41,7 @@ protected: virtual ~AccessibleBrowseBoxTable(); public: - // XAccessibleContext ----------------------------------------------------- + // XAccessibleContext /** @return The XAccessible interface of the specified child. */ virtual css::uno::Reference< css::accessibility::XAccessible > SAL_CALL @@ -56,7 +53,7 @@ public: virtual sal_Int32 SAL_CALL getAccessibleIndexInParent() throw ( css::uno::RuntimeException, std::exception ) override; - // XAccessibleComponent --------------------------------------------------- + // XAccessibleComponent /** @return The accessible child rendered under the given point. */ virtual css::uno::Reference< css::accessibility::XAccessible > SAL_CALL @@ -67,7 +64,7 @@ public: virtual void SAL_CALL grabFocus() throw ( css::uno::RuntimeException, std::exception ) override; - // XAccessibleTable ------------------------------------------------------- + // XAccessibleTable /** @return The description text of the specified row. */ virtual OUString SAL_CALL getAccessibleRowDescription( sal_Int32 nRow ) @@ -99,12 +96,12 @@ public: getSelectedAccessibleColumns() throw ( css::uno::RuntimeException, std::exception ) override; - /** @return , if the specified row is completely selected. */ + /** @return TRUE, if the specified row is completely selected. */ virtual sal_Bool SAL_CALL isAccessibleRowSelected( sal_Int32 nRow ) throw ( css::lang::IndexOutOfBoundsException, css::uno::RuntimeException, std::exception ) override; - /** @return , if the specified column is completely selected. */ + /** @return TRUE, if the specified column is completely selected. */ virtual sal_Bool SAL_CALL isAccessibleColumnSelected( sal_Int32 nColumn ) throw ( css::lang::IndexOutOfBoundsException, css::uno::RuntimeException, std::exception ) override; @@ -116,19 +113,19 @@ public: throw ( css::lang::IndexOutOfBoundsException, css::uno::RuntimeException, std::exception ) override; - /** @return , if the specified cell is selected. */ + /** @return TRUE, if the specified cell is selected. */ virtual sal_Bool SAL_CALL isAccessibleSelected( sal_Int32 nRow, sal_Int32 nColumn ) throw ( css::lang::IndexOutOfBoundsException, css::uno::RuntimeException, std::exception ) override; - // XServiceInfo ----------------------------------------------------------- + // XServiceInfo /** @return The name of this class. */ virtual OUString SAL_CALL getImplementationName() throw ( css::uno::RuntimeException, std::exception ) override; protected: - // internal virtual methods ----------------------------------------------- + // internal virtual methods /** @attention This method requires locked mutex's and a living object. @return The bounding box (VCL rect.) relative to the parent window. */ @@ -137,7 +134,7 @@ protected: @return The bounding box (VCL rect.) in screen coordinates. */ virtual Rectangle implGetBoundingBoxOnScreen() override; - // internal helper methods ------------------------------------------------ + // internal helper methods /** @attention This method requires a locked mutex. @return The XAccessibleTable interface of the specified header bar. */ diff --git a/accessibility/inc/accessibility/extended/AccessibleBrowseBoxTableBase.hxx b/accessibility/inc/accessibility/extended/AccessibleBrowseBoxTableBase.hxx index d20dc11fd197..bdbf4b4e1517 100644 --- a/accessibility/inc/accessibility/extended/AccessibleBrowseBoxTableBase.hxx +++ b/accessibility/inc/accessibility/extended/AccessibleBrowseBoxTableBase.hxx @@ -59,7 +59,7 @@ protected: virtual ~AccessibleBrowseBoxTableBase(); public: - // XAccessibleContext ----------------------------------------------------- + // XAccessibleContext /** @return The count of visible children. */ virtual sal_Int32 SAL_CALL getAccessibleChildCount() @@ -73,13 +73,13 @@ public: - getAccessibleChild, - getAccessibleIndexInParent. */ - // XAccessibleComponent --------------------------------------------------- + // XAccessibleComponent /* Derived classes have to implement: - getAccessibleAt, - grabFocus. */ - // XAccessibleTable ------------------------------------------------------- + // XAccessibleTable /** @return The number of used rows in the table (0 = empty table). */ virtual sal_Int32 SAL_CALL getAccessibleRowCount() @@ -140,7 +140,7 @@ public: - getAccessibleCellAt, - isAccessibleSelected. */ - // XInterface ------------------------------------------------------------- + // XInterface /** Queries for a new interface. */ css::uno::Any SAL_CALL queryInterface( const css::uno::Type& rType ) @@ -152,7 +152,7 @@ public: /** Releases the object (calls release() on base class). */ virtual void SAL_CALL release() throw () override; - // XTypeProvider ---------------------------------------------------------- + // XTypeProvider /** @return A sequence of possible types (received from base classes). */ virtual css::uno::Sequence< css::uno::Type > SAL_CALL getTypes() @@ -162,13 +162,13 @@ public: virtual css::uno::Sequence< sal_Int8 > SAL_CALL getImplementationId() throw ( css::uno::RuntimeException, std::exception ) override; - // XServiceInfo ----------------------------------------------------------- + // XServiceInfo /* Derived classes have to implement: - getImplementationName */ protected: - // internal virtual methods ----------------------------------------------- + // internal virtual methods /** @attention This method requires locked mutex's and a living object. @return The count of data rows without header bar. */ @@ -177,9 +177,9 @@ protected: @return The count of data columns without "handle column". */ virtual sal_Int32 implGetColumnCount() const; - // internal helper methods ------------------------------------------------ + // internal helper methods - /** @return , if first BrowseBox column is the "handle column". */ + /** @return TRUE, if first BrowseBox column is the "handle column". */ bool implHasHandleColumn() const; /** @attention This method requires locked mutex's and a living object. @@ -205,19 +205,19 @@ protected: sal_Int32 implGetChildIndex( sal_Int32 nRow, sal_Int32 nColumn ) const; /** @attention This method requires locked mutex's and a living object. - @return , if the specified row is selected. */ + @return TRUE, if the specified row is selected. */ bool implIsRowSelected( sal_Int32 nRow ) const; /** @attention This method requires locked mutex's and a living object. - @return , if the specified column is selected. */ + @return TRUE, if the specified column is selected. */ bool implIsColumnSelected( sal_Int32 nColumn ) const; /** Selects/deselects a row (tries to expand selection). @attention This method requires locked mutex's and a living object. - @param bSelect = select, = deselect */ + @param bSelect TRUE = select, FALSE = deselect */ void implSelectRow( sal_Int32 nRow, bool bSelect ); /** Selects/deselects a column (tries to expand selection). @attention This method requires locked mutex's and a living object. - @param bSelect = select, = deselect */ + @param bSelect TRUE = select, FALSE = deselect */ void implSelectColumn( sal_Int32 nColumnPos, bool bSelect ); /** @attention This method requires locked mutex's and a living object. diff --git a/accessibility/inc/accessibility/extended/AccessibleGridControlBase.hxx b/accessibility/inc/accessibility/extended/AccessibleGridControlBase.hxx index c844c040f4d6..583566299c3f 100644 --- a/accessibility/inc/accessibility/extended/AccessibleGridControlBase.hxx +++ b/accessibility/inc/accessibility/extended/AccessibleGridControlBase.hxx @@ -50,13 +50,8 @@ namespace utl { } - namespace accessibility { - - - - typedef ::cppu::WeakAggComponentImplHelper4< css::accessibility::XAccessibleContext, css::accessibility::XAccessibleComponent, @@ -89,7 +84,7 @@ protected: virtual void SAL_CALL disposing() override; public: - // XAccessibleContext ----------------------------------------------------- + // XAccessibleContext /** @return A reference to the parent accessible object. */ virtual css::uno::Reference< css::accessibility::XAccessible > SAL_CALL @@ -142,10 +137,10 @@ public: Derived classes may overwrite getAccessibleIndexInParent to increase performance. */ - // XAccessibleComponent --------------------------------------------------- + // XAccessibleComponent /** @return - , if the point lies within the bounding box of this object. */ + TRUE, if the point lies within the bounding box of this object. */ virtual sal_Bool SAL_CALL containsPoint( const css::awt::Point& rPoint ) throw ( css::uno::RuntimeException, std::exception ) override; @@ -182,7 +177,7 @@ public: getAccessibleAtPoint( const css::awt::Point& rPoint ) throw ( css::uno::RuntimeException, std::exception ) override; - // XAccessibleEventBroadcaster -------------------------------------------- + // XAccessibleEventBroadcaster /** Adds a new event listener */ virtual void SAL_CALL addAccessibleEventListener( @@ -194,13 +189,13 @@ public: const css::uno::Reference< css::accessibility::XAccessibleEventListener>& rxListener ) throw ( css::uno::RuntimeException, std::exception ) override; - // XTypeProvider ---------------------------------------------------------- + // XTypeProvider /** @return An unique implementation ID. */ virtual css::uno::Sequence< sal_Int8 > SAL_CALL getImplementationId() throw ( css::uno::RuntimeException, std::exception ) override; - // XServiceInfo ----------------------------------------------------------- + // XServiceInfo /** @return Whether the specified service is supported by this class. */ virtual sal_Bool SAL_CALL supportsService( const OUString& rServiceName ) @@ -214,7 +209,7 @@ public: /* Derived classes have to implement: - getImplementationName. */ - // helper methods --------------------------------------------------------- + // helper methods /** @return The GridControl object type. */ inline ::svt::table::AccessibleTableControlObjType getType() const; @@ -224,17 +219,17 @@ public: sal_Int16 nEventId, const css::uno::Any& rNewValue, const css::uno::Any& rOldValue ); - /** @return , if the object is not disposed or disposing. */ + /** @return TRUE, if the object is not disposed or disposing. */ bool isAlive() const; protected: - // internal virtual methods ----------------------------------------------- + // internal virtual methods /** Determines whether the Grid control is really showing inside of its parent accessible window. Derived classes may implement different behaviour. @attention This method requires locked mutex's and a living object. - @return , if the object is really showing. */ + @return TRUE, if the object is really showing. */ bool implIsShowing(); /** Derived classes return the bounding box relative to the parent window. @@ -254,7 +249,7 @@ protected: @return A filled AccessibleStateSetHelper. */ virtual ::utl::AccessibleStateSetHelper* implCreateStateSetHelper(); - // internal helper methods ------------------------------------------------ + // internal helper methods /** @throws DisposedException If the object is not alive. */ void ensureIsAlive() const @@ -279,7 +274,7 @@ protected: void setClientId(::comphelper::AccessibleEventNotifier::TClientId _aNewClientId) { m_aClientId = _aNewClientId; } protected: - // members ---------------------------------------------------------------- + // members /** The parent accessible object. */ css::uno::Reference< css::accessibility::XAccessible > m_xParent; @@ -330,7 +325,7 @@ protected: virtual ~GridControlAccessibleElement(); protected: - // XAccessible ------------------------------------------------------------ + // XAccessible /** @return The XAccessibleContext interface of this object. */ virtual css::uno::Reference< css::accessibility::XAccessibleContext > SAL_CALL @@ -342,7 +337,7 @@ private: GridControlAccessibleElement& operator=( const GridControlAccessibleElement& ) = delete; }; -// inlines -------------------------------------------------------------------- +// inlines inline ::svt::table::AccessibleTableControlObjType AccessibleGridControlBase::getType() const { diff --git a/accessibility/inc/accessibility/extended/AccessibleGridControlHeader.hxx b/accessibility/inc/accessibility/extended/AccessibleGridControlHeader.hxx index 927014a6024a..8d47736fc844 100644 --- a/accessibility/inc/accessibility/extended/AccessibleGridControlHeader.hxx +++ b/accessibility/inc/accessibility/extended/AccessibleGridControlHeader.hxx @@ -50,7 +50,7 @@ protected: virtual ~AccessibleGridControlHeader(); public: - // XAccessibleContext ----------------------------------------------------- + // XAccessibleContext /** @return The XAccessible interface of the specified child. @@ -64,7 +64,7 @@ public: virtual sal_Int32 SAL_CALL getAccessibleIndexInParent() throw ( css::uno::RuntimeException, std::exception ) override; - // XAccessibleComponent --------------------------------------------------- + // XAccessibleComponent /** @return The accessible child rendered under the given point. */ virtual css::uno::Reference< css::accessibility::XAccessible > SAL_CALL @@ -75,7 +75,7 @@ public: virtual void SAL_CALL grabFocus() throw ( css::uno::RuntimeException, std::exception ) override; - // XAccessibleTable ------------------------------------------------------- + // XAccessibleTable /** @return The description text of the specified row. */ virtual OUString SAL_CALL @@ -109,12 +109,12 @@ public: getSelectedAccessibleColumns() throw ( css::uno::RuntimeException, std::exception ) override; - /** @return , if the specified row is completely selected. */ + /** @return TRUE, if the specified row is completely selected. */ virtual sal_Bool SAL_CALL isAccessibleRowSelected( sal_Int32 nRow ) throw ( css::lang::IndexOutOfBoundsException, css::uno::RuntimeException, std::exception ) override; - /** @return , if the specified column is completely selected. */ + /** @return TRUE, if the specified column is completely selected. */ virtual sal_Bool SAL_CALL isAccessibleColumnSelected( sal_Int32 nColumn ) throw ( css::lang::IndexOutOfBoundsException, css::uno::RuntimeException, std::exception ) override; @@ -126,12 +126,12 @@ public: throw ( css::lang::IndexOutOfBoundsException, css::uno::RuntimeException, std::exception ) override; - /** @return , if the specified cell is selected. */ + /** @return TRUE, if the specified cell is selected. */ virtual sal_Bool SAL_CALL isAccessibleSelected( sal_Int32 nRow, sal_Int32 nColumn ) throw ( css::lang::IndexOutOfBoundsException, css::uno::RuntimeException, std::exception ) override; - // XServiceInfo ----------------------------------------------------------- + // XServiceInfo /** @return The name of this class. */ virtual OUString SAL_CALL getImplementationName() @@ -155,15 +155,15 @@ protected: @return The bounding box (VCL rect.) in screen coordinates. */ virtual Rectangle implGetBoundingBoxOnScreen() override; - // internal helper methods ------------------------------------------------ + // internal helper methods - /** @return , if the objects is a header bar for rows. */ + /** @return TRUE, if the objects is a header bar for rows. */ inline bool isRowBar() const; - /** @return , if the objects is a header bar for columns. */ + /** @return TRUE, if the objects is a header bar for columns. */ inline bool isColumnBar() const; }; -// inlines -------------------------------------------------------------------- +// inlines inline bool AccessibleGridControlHeader::isRowBar() const { diff --git a/accessibility/inc/accessibility/extended/AccessibleGridControlTable.hxx b/accessibility/inc/accessibility/extended/AccessibleGridControlTable.hxx index 26ebe5f43a58..dae53abdd6c1 100644 --- a/accessibility/inc/accessibility/extended/AccessibleGridControlTable.hxx +++ b/accessibility/inc/accessibility/extended/AccessibleGridControlTable.hxx @@ -50,7 +50,7 @@ private: std::vector< AccessibleGridControlTableCell* > m_pCellVector; std::vector< css::uno::Reference< css::accessibility::XAccessible> > m_pAccessCellVector; public: - // XAccessibleContext ----------------------------------------------------- + // XAccessibleContext /** @return The XAccessible interface of the specified child. */ virtual css::uno::Reference< css::accessibility::XAccessible > SAL_CALL @@ -62,7 +62,7 @@ public: virtual sal_Int32 SAL_CALL getAccessibleIndexInParent() throw ( css::uno::RuntimeException, std::exception ) override; - // XAccessibleComponent --------------------------------------------------- + // XAccessibleComponent /** @return The accessible child rendered under the given point. */ virtual css::uno::Reference< css::accessibility::XAccessible > SAL_CALL @@ -73,7 +73,7 @@ public: virtual void SAL_CALL grabFocus() throw ( css::uno::RuntimeException, std::exception ) override; - // XAccessibleTable ------------------------------------------------------- + // XAccessibleTable /** @return The description text of the specified row. */ virtual OUString SAL_CALL getAccessibleRowDescription( sal_Int32 nRow ) @@ -105,12 +105,12 @@ public: getSelectedAccessibleColumns() throw ( css::uno::RuntimeException, std::exception ) override; - /** @return , if the specified row is completely selected. */ + /** @return TRUE, if the specified row is completely selected. */ virtual sal_Bool SAL_CALL isAccessibleRowSelected( sal_Int32 nRow ) throw ( css::lang::IndexOutOfBoundsException, css::uno::RuntimeException, std::exception ) override; - /** @return , if the specified column is completely selected. */ + /** @return TRUE, if the specified column is completely selected. */ virtual sal_Bool SAL_CALL isAccessibleColumnSelected( sal_Int32 nColumn ) throw ( css::lang::IndexOutOfBoundsException, css::uno::RuntimeException, std::exception ) override; @@ -122,19 +122,19 @@ public: throw ( css::lang::IndexOutOfBoundsException, css::uno::RuntimeException, std::exception ) override; - /** @return , if the specified cell is selected. */ + /** @return TRUE, if the specified cell is selected. */ virtual sal_Bool SAL_CALL isAccessibleSelected( sal_Int32 nRow, sal_Int32 nColumn ) throw ( css::lang::IndexOutOfBoundsException, css::uno::RuntimeException, std::exception ) override; - // XAccessibleSelection --------------------------------------------------- + // XAccessibleSelection /** Selects the specified child (row or column of the table). */ virtual void SAL_CALL selectAccessibleChild( sal_Int32 nChildIndex ) throw ( css::lang::IndexOutOfBoundsException, css::uno::RuntimeException, std::exception ) override; - /** @return , if the specified child (row/column) is selected. */ + /** @return TRUE, if the specified child (row/column) is selected. */ virtual sal_Bool SAL_CALL isAccessibleChildSelected( sal_Int32 nChildIndex ) throw ( css::lang::IndexOutOfBoundsException, css::uno::RuntimeException, std::exception ) override; @@ -161,7 +161,7 @@ public: virtual void SAL_CALL deselectAccessibleChild( sal_Int32 nSelectedChildIndex ) throw ( css::lang::IndexOutOfBoundsException, css::uno::RuntimeException, std::exception ) override; - // XInterface ------------------------------------------------------------- + // XInterface /** Queries for a new interface. */ css::uno::Any SAL_CALL queryInterface( const css::uno::Type& rType ) @@ -172,7 +172,7 @@ public: /** Releases the object (calls release() on base class). */ virtual void SAL_CALL release() throw () override; - // XServiceInfo ----------------------------------------------------------- + // XServiceInfo /** @return The name of this class. */ virtual OUString SAL_CALL getImplementationName() @@ -184,7 +184,7 @@ public: std::vector< css::uno::Reference< css::accessibility::XAccessible > >& getAccessibleCellVector() { return m_pAccessCellVector;} protected: - // internal virtual methods ----------------------------------------------- + // internal virtual methods /** @attention This method requires locked mutex's and a living object. @return The bounding box (VCL rect.) relative to the parent window. */ @@ -194,7 +194,7 @@ protected: virtual Rectangle implGetBoundingBoxOnScreen() override; - //// internal helper methods ------------------------------------------------ + //// internal helper methods ///** @attention This method requires a locked mutex. // @return The XAccessibleTable interface of the specified header bar. */ css::uno::Reference< css::accessibility::XAccessibleTable > -- cgit