summaryrefslogtreecommitdiff
path: root/accessibility/inc/accessibility
diff options
context:
space:
mode:
authorChris Sherlock <chris.sherlock79@gmail.com>2016-02-04 14:54:41 +1100
committerChris Sherlock <chris.sherlock79@gmail.com>2016-02-04 17:26:10 +1100
commit777ad8f5d5b140af0b6959995b8838bf50a578ec (patch)
treeb0545d8c1324045ca8cfc6a8f4c1ef1f30643414 /accessibility/inc/accessibility
parent0e414e1433acf775c17063cc748818ee7dd822e3 (diff)
accessibility: fix doxygen errors
Change-Id: Ib1bed3e4df91ad00ecf2deb5c3d135cc2f5561b5
Diffstat (limited to 'accessibility/inc/accessibility')
-rw-r--r--accessibility/inc/accessibility/extended/AccessibleBrowseBoxBase.hxx6
-rw-r--r--accessibility/inc/accessibility/extended/AccessibleBrowseBoxHeaderBar.hxx30
-rw-r--r--accessibility/inc/accessibility/standard/vclxaccessiblebox.hxx15
-rw-r--r--accessibility/inc/accessibility/standard/vclxaccessiblecombobox.hxx4
-rw-r--r--accessibility/inc/accessibility/standard/vclxaccessibledropdowncombobox.hxx4
-rw-r--r--accessibility/inc/accessibility/standard/vclxaccessibledropdownlistbox.hxx4
-rw-r--r--accessibility/inc/accessibility/standard/vclxaccessiblelist.hxx13
-rw-r--r--accessibility/inc/accessibility/standard/vclxaccessiblelistbox.hxx2
-rw-r--r--accessibility/inc/accessibility/standard/vclxaccessibletextfield.hxx10
9 files changed, 42 insertions, 46 deletions
diff --git a/accessibility/inc/accessibility/extended/AccessibleBrowseBoxBase.hxx b/accessibility/inc/accessibility/extended/AccessibleBrowseBoxBase.hxx
index 89513226d9a5..66b49a84e209 100644
--- a/accessibility/inc/accessibility/extended/AccessibleBrowseBoxBase.hxx
+++ b/accessibility/inc/accessibility/extended/AccessibleBrowseBoxBase.hxx
@@ -169,7 +169,7 @@ public:
// XAccessibleComponent ---------------------------------------------------
/** @return
- <TRUE/>, 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;
@@ -255,7 +255,7 @@ public:
sal_Int16 nEventId,
const css::uno::Any& rNewValue,
const css::uno::Any& rOldValue );
- /** @return <TRUE/>, if the object is not disposed or disposing. */
+ /** @return TRUE, if the object is not disposed or disposing. */
bool isAlive() const;
protected:
@@ -265,7 +265,7 @@ protected:
its parent accessible window. Derived classes may implement different
behaviour.
@attention This method requires locked mutex's and a living object.
- @return <TRUE/>, 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.
diff --git a/accessibility/inc/accessibility/extended/AccessibleBrowseBoxHeaderBar.hxx b/accessibility/inc/accessibility/extended/AccessibleBrowseBoxHeaderBar.hxx
index 544ba078b2ba..3b1260ceeaea 100644
--- a/accessibility/inc/accessibility/extended/AccessibleBrowseBoxHeaderBar.hxx
+++ b/accessibility/inc/accessibility/extended/AccessibleBrowseBoxHeaderBar.hxx
@@ -54,7 +54,7 @@ protected:
virtual ~AccessibleBrowseBoxHeaderBar();
public:
- // XAccessibleContext -----------------------------------------------------
+ // XAccessibleContext
/** @return
The XAccessible interface of the specified child.
@@ -69,7 +69,7 @@ public:
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
@@ -80,7 +80,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
@@ -113,12 +113,12 @@ public:
getSelectedAccessibleColumns()
throw ( css::uno::RuntimeException, std::exception ) override;
- /** @return <TRUE/>, 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 <TRUE/>, 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;
@@ -130,19 +130,19 @@ public:
throw ( css::lang::IndexOutOfBoundsException,
css::uno::RuntimeException, std::exception ) override;
- /** @return <TRUE/>, 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 <TRUE/>, 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;
@@ -170,7 +170,7 @@ public:
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 )
@@ -182,7 +182,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()
@@ -193,7 +193,7 @@ public:
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. */
@@ -209,11 +209,11 @@ protected:
@return The count of used columns. */
virtual sal_Int32 implGetColumnCount() const override;
- // internal helper methods ------------------------------------------------
+ // internal helper methods
- /** @return <TRUE/>, 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 <TRUE/>, if the objects is a header bar for columns. */
+ /** @return TRUE, if the objects is a header bar for columns. */
inline bool isColumnBar() const;
/** Returns the specified row or column. Uses one of the parameters,
@@ -237,7 +237,7 @@ protected:
throw ( css::lang::IndexOutOfBoundsException );
};
-// inlines --------------------------------------------------------------------
+// inlines
inline bool AccessibleBrowseBoxHeaderBar::isRowBar() const
{
diff --git a/accessibility/inc/accessibility/standard/vclxaccessiblebox.hxx b/accessibility/inc/accessibility/standard/vclxaccessiblebox.hxx
index 393cac094421..d079292062a1 100644
--- a/accessibility/inc/accessibility/standard/vclxaccessiblebox.hxx
+++ b/accessibility/inc/accessibility/standard/vclxaccessiblebox.hxx
@@ -37,7 +37,7 @@ typedef ::cppu::ImplHelper3<
/** Base class for list- and combo boxes. This class manages the box'
children. The classed derived from this one have only to implement the
- <member>IsValid</member> method and return the correct implementation name.
+ IsValid method and return the correct implementation name.
*/
class VCLXAccessibleBox
: public VCLXAccessibleComponent,
@@ -47,7 +47,7 @@ public:
enum BoxType {COMBOBOX, LISTBOX};
/** The constructor is initialized with the box type which may be
- either <const>COMBOBOX</const> or <const>LISTBOX</const> and a flag
+ either COMBOBOX or LISTBOX and a flag
indicating whether the box is a drop down box.
*/
VCLXAccessibleBox (VCLXWindow* pVCLXindow, BoxType aType, bool bIsDropDownBox);
@@ -74,14 +74,13 @@ public:
sal_Int32 SAL_CALL getAccessibleChildCount()
throw (css::uno::RuntimeException, std::exception) override;
/** For drop down list boxes the text field is a not editable
- <type>VCLXAccessibleTextField</type>, for combo boxes it is an
- editable <type>VLCAccessibleEdit</type>.
+ VCLXAccessibleTextField, for combo boxes it is an
+ editable VLCAccessibleEdit.
*/
css::uno::Reference< css::accessibility::XAccessible> SAL_CALL
getAccessibleChild (sal_Int32 i)
throw (css::lang::IndexOutOfBoundsException, css::uno::RuntimeException, std::exception) override;
- /** The role is always <const
- scope="com::sun::star::accessibility">AccessibleRole::COMBO_BOX</const>.
+ /** The role is always AccessibleRole::COMBO_BOX.
*/
sal_Int16 SAL_CALL getAccessibleRole()
throw (css::uno::RuntimeException, std::exception) override;
@@ -102,7 +101,7 @@ public:
throw (css::lang::IndexOutOfBoundsException,
css::uno::RuntimeException, std::exception) override;
/** The returned string is associated with resource
- <const>RID_STR_ACC_ACTION_TOGGLEPOPUP</const>.
+ RID_STR_ACC_ACTION_TOGGLEPOPUP.
*/
virtual OUString SAL_CALL getAccessibleActionDescription (sal_Int32 nIndex)
throw (css::lang::IndexOutOfBoundsException,
@@ -168,7 +167,7 @@ protected:
virtual ~VCLXAccessibleBox();
- /** Returns </true> when the object is valid.
+ /** Returns true when the object is valid.
*/
virtual bool IsValid() const = 0;
diff --git a/accessibility/inc/accessibility/standard/vclxaccessiblecombobox.hxx b/accessibility/inc/accessibility/standard/vclxaccessiblecombobox.hxx
index 8744a2419f5f..082bd30d0990 100644
--- a/accessibility/inc/accessibility/standard/vclxaccessiblecombobox.hxx
+++ b/accessibility/inc/accessibility/standard/vclxaccessiblecombobox.hxx
@@ -26,9 +26,9 @@
/** The accessible combobox has two children. The first is the text field
- represented by an object of the <type>VCLXAccessibleEdit</type> class.
+ represented by an object of the VCLXAccessibleEdit class.
The second is the list containing all items and is represented by an
- object of the <type>VCLXAccessibleList</type> class which does not
+ object of the VCLXAccessibleList class which does not
support selection at the moment.
*/
class VCLXAccessibleComboBox
diff --git a/accessibility/inc/accessibility/standard/vclxaccessibledropdowncombobox.hxx b/accessibility/inc/accessibility/standard/vclxaccessibledropdowncombobox.hxx
index 55c02ab6d56c..ab6d71bed276 100644
--- a/accessibility/inc/accessibility/standard/vclxaccessibledropdowncombobox.hxx
+++ b/accessibility/inc/accessibility/standard/vclxaccessibledropdowncombobox.hxx
@@ -26,9 +26,9 @@
/** The accessible drop down combobox has two children. The first is the
text field represented by an object of the
- <type>VCLXAccessibleEdit</type> class. The second is the list
+ VCLXAccessibleEdit class. The second is the list
containing all items and is represented by an object of the
- <type>VCLXAccessibleList</type> class which does not support selection
+ VCLXAccessibleList class which does not support selection
at the moment.
*/
class VCLXAccessibleDropDownComboBox : public VCLXAccessibleBox
diff --git a/accessibility/inc/accessibility/standard/vclxaccessibledropdownlistbox.hxx b/accessibility/inc/accessibility/standard/vclxaccessibledropdownlistbox.hxx
index d2d3251908a5..23f1ab4ba9b0 100644
--- a/accessibility/inc/accessibility/standard/vclxaccessibledropdownlistbox.hxx
+++ b/accessibility/inc/accessibility/standard/vclxaccessibledropdownlistbox.hxx
@@ -25,9 +25,9 @@
/** The accessible drop down combobox has two children. The first is the
text field represented by an object of the
- <type>VCLXAccessibleTextField</type> class which can not be edited. The
+ VCLXAccessibleTextField class which can not be edited. The
second is the list containing all items and is represented by an object
- of the <type>VCLXAccessibleListBoxList</type> class which does support
+ of the VCLXAccessibleListBoxList class which does support
selection.
*/
class VCLXAccessibleDropDownListBox : public VCLXAccessibleBox
diff --git a/accessibility/inc/accessibility/standard/vclxaccessiblelist.hxx b/accessibility/inc/accessibility/standard/vclxaccessiblelist.hxx
index bbd19d49f0ca..86b3a04238f5 100644
--- a/accessibility/inc/accessibility/standard/vclxaccessiblelist.hxx
+++ b/accessibility/inc/accessibility/standard/vclxaccessiblelist.hxx
@@ -61,7 +61,7 @@ public:
css::accessibility::XAccessible >& _xParent);
/** The index that is passed to this method is returned on following
- calls to <member>getAccessibleIndexInParent</member>.
+ calls to getAccessibleIndexInParent.
*/
void SetIndexInParent (sal_Int32 nIndex);
@@ -103,7 +103,7 @@ public:
throw (css::uno::RuntimeException, std::exception) override;
/** The index returned as index in parent is always the one set with the
- <member>SetIndexInParent()</member> method.
+ SetIndexInParent() method.
*/
virtual sal_Int32 SAL_CALL getAccessibleIndexInParent()
throw (css::uno::RuntimeException, std::exception) override;
@@ -158,8 +158,8 @@ protected:
virtual void SAL_CALL disposing() override;
/** This method adds the states
- <const>AccessibleStateType::FOCUSABLE</const> and possibly
- <const>AccessibleStateType::MULTI_SELECTABLE</const> to the state set
+ AccessibleStateType::FOCUSABLE and possibly
+ AccessibleStateType::MULTI_SELECTABLE to the state set
of the base classes.
*/
virtual void FillAccessibleStateSet (utl::AccessibleStateSetHelper& rStateSet) override;
@@ -173,8 +173,7 @@ protected:
/** Call this method when the item list has been changed, i.e. items
have been deleted or inserted.
@param bItemInserted
- Indicate whether items have been inserted (<TRUE/>) or removed
- (<FALSE/>).
+ Indicate whether items have been inserted (TRUE) or removed (FALSE).
@param nIndex
Index of the new or removed item. A value of -1 indicates that
the whole list has been cleared.
@@ -185,7 +184,7 @@ protected:
virtual css::awt::Rectangle implGetBounds( ) throw (css::uno::RuntimeException) override;
private:
- /** We need to save the accessible parent to return it in <type>getAccessibleParent()</type>,
+ /** We need to save the accessible parent to return it in getAccessibleParent(),
because this method of the base class returns the wrong parent.
*/
css::uno::Reference< css::accessibility::XAccessible > m_xParent;
diff --git a/accessibility/inc/accessibility/standard/vclxaccessiblelistbox.hxx b/accessibility/inc/accessibility/standard/vclxaccessiblelistbox.hxx
index a9921c78d5df..d015b4b79a4d 100644
--- a/accessibility/inc/accessibility/standard/vclxaccessiblelistbox.hxx
+++ b/accessibility/inc/accessibility/standard/vclxaccessiblelistbox.hxx
@@ -28,7 +28,7 @@
/** The accessible drop down combobox has one children. It is the list
containing all items and is represented by an object of the
- <type>VCLXAccessibleListBoxList</type> class which does support
+ VCLXAccessibleListBoxList class which does support
selection.
*/
class VCLXAccessibleListBox : public VCLXAccessibleBox
diff --git a/accessibility/inc/accessibility/standard/vclxaccessibletextfield.hxx b/accessibility/inc/accessibility/standard/vclxaccessibletextfield.hxx
index a91b92681c78..58ec93b94392 100644
--- a/accessibility/inc/accessibility/standard/vclxaccessibletextfield.hxx
+++ b/accessibility/inc/accessibility/standard/vclxaccessibletextfield.hxx
@@ -24,13 +24,11 @@
#include <cppuhelper/implbase1.hxx>
-typedef ::cppu::ImplHelper1<
- css::accessibility::XAccessible
- > VCLXAccessible_BASE;
+typedef ::cppu::ImplHelper1< css::accessibility::XAccessible > VCLXAccessible_BASE;
/** This class represents non editable text fields. The object passed to
- the constructor is expected to be a list (a <type>ListBox</type> to be
+ the constructor is expected to be a list (a ListBox to be
more specific). From this always the selected item is token to be made
accessible by this class. When the selected item changes then also the
exported text changes.
@@ -78,12 +76,12 @@ protected:
virtual ~VCLXAccessibleTextField();
/** With this method the text of the currently selected item is made
- available to the <type>VCLXAccessibleTextComponent</type> base class.
+ available to the VCLXAccessibleTextComponent base class.
*/
OUString implGetText() override;
private:
- /** We need to save the accessible parent to return it in <type>getAccessibleParent()</type>,
+ /** We need to save the accessible parent to return it in getAccessibleParent(),
because this method of the base class returns the wrong parent.
*/
css::uno::Reference< css::accessibility::XAccessible > m_xParent;