mir/libreoffice
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

accessibility: fix rest of doxygen errors

Browse Source 
I've changed the doxygen generation script to generate an xhtml
page, and it uses SVG diagrams now.

Change-Id: I876795675ae9ebcfec6f7fe5edc43c9d2e4964d3
This commit is contained in:
Chris Sherlock
2016-02-04 19:50:15 +11:00
parent e1acc9f043
commit e2a6b1378f
10 changed files with 90 additions and 95 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
accessibility/inc/accessibility/extended/AccessibleBrowseBox.hxx
View File

@@ -105,6 +105,8 @@ public:
the new value
@param rOldValue
the old value
@param _bColumnHeaderBar
true if a column based header bar, false if a row based header bar
*/
void commitHeaderBarEvent(sal_Int16 nEventId,
const css::uno::Any& rNewValue,

101
accessibility/inc/accessibility/extended/AccessibleBrowseBoxBase.hxx
View File

@@ -57,12 +57,8 @@ namespace svt {
class IAccessibleTableProvider;
}
namespace accessibility {
typedef ::cppu::WeakAggComponentImplHelper5<
css::accessibility::XAccessibleContext,
css::accessibility::XAccessibleComponent,
@@ -84,30 +80,31 @@ public:
implSetName() (in Ctor) or later via
setAccessibleName() and setAccessibleDescription() (these methods
notify the listeners about the change).
@param rxParent XAccessible interface of the parent object.
@param rBrowseBox The BrowseBox control.
@param eNameText The constant for the name text.
@param eDescrText The constant for the description text. */
@param rxParent XAccessible interface of the parent object.
@param rBrowseBox The BrowseBox control.
@param _xFocusWindow The window that gets all the focus events.
@param eObjType Object type */
AccessibleBrowseBoxBase(
const css::uno::Reference<
css::accessibility::XAccessible >& rxParent,
::svt::IAccessibleTableProvider& rBrowseBox,
const css::uno::Reference< css::accessibility::XAccessible >& rxParent,
::svt::IAccessibleTableProvider& rBrowseBox,
const css::uno::Reference< css::awt::XWindow >& _xFocusWindow,
::svt::AccessibleBrowseBoxObjType eObjType );
::svt::AccessibleBrowseBoxObjType eObjType );
/** Constructor sets specified name and description.
@param rxParent XAccessible interface of the parent object.
@param rBrowseBox The BrowseBox control.
@param rName The name of this object.
@param rDescription The description text of this object. */
@param rxParent XAccessible interface of the parent object.
@param rBrowseBox The BrowseBox control.
@param _xFocusWindow The window that gets all the focus events.
@param eObjType Object type
@param rName The name of this object.
@param rDescription The description text of this object. */
AccessibleBrowseBoxBase(
const css::uno::Reference<
css::accessibility::XAccessible >& rxParent,
::svt::IAccessibleTableProvider& rBrowseBox,
const css::uno::Reference< css::accessibility::XAccessible >& rxParent,
::svt::IAccessibleTableProvider& rBrowseBox,
const css::uno::Reference< css::awt::XWindow >& _xFocusWindow,
::svt::AccessibleBrowseBoxObjType eObjType,
const OUString& rName,
const OUString& rDescription );
::svt::AccessibleBrowseBoxObjType eObjType,
const OUString& rName,
const OUString& rDescription );
protected:
virtual ~AccessibleBrowseBoxBase();
@@ -116,7 +113,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 getAccessibleParent()
@@ -166,7 +163,7 @@ public:
Derived classes may overwrite getAccessibleIndexInParent to increase
performance. */
// XAccessibleComponent ---------------------------------------------------
// XAccessibleComponent
/** @return
TRUE, if the point lies within the bounding box of this object. */
@@ -209,7 +206,7 @@ public:
virtual css::uno::Reference< css::accessibility::XAccessible > SAL_CALL 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(
@@ -221,13 +218,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 )
@@ -240,7 +237,7 @@ public:
/* Derived classes have to implement:
- getImplementationName. */
// helper methods ---------------------------------------------------------
// helper methods
/** @return The BrowseBox object type. */
inline ::svt::AccessibleBrowseBoxObjType getType() const;
@@ -259,7 +256,7 @@ public:
bool isAlive() const;
protected:
// internal virtual methods -----------------------------------------------
// internal virtual methods
/** Determines whether the BrowseBox control is really showing inside of
its parent accessible window. Derived classes may implement different
@@ -285,13 +282,13 @@ protected:
@return A filled AccessibleStateSetHelper. */
virtual ::utl::AccessibleStateSetHelper* implCreateStateSetHelper();
// internal helper methods ------------------------------------------------
// internal helper methods
/** @throws <type>DisposedException</type> If the object is not alive. */
void ensureIsAlive() const
throw ( css::lang::DisposedException );
/** @return The ::osl::Mutex member provided by the class OBaseMutex. */
/** @return The osl::Mutex member provided by the class OBaseMutex. */
inline ::osl::Mutex& getOslMutex();
/** Changes the name of the object (flat assignment, no notify).
@@ -320,7 +317,7 @@ public:
inline void ensureIsAlive( const AccessControl& ) { ensureIsAlive(); }
protected:
// members ----------------------------------------------------------------
// members
/** The parent accessible object. */
css::uno::Reference< css::accessibility::XAccessible > mxParent;
@@ -362,33 +359,33 @@ protected:
setAccessibleName() and setAccessibleDescription() (these methods
notify the listeners about the change).
@param rxParent XAccessible interface of the parent object.
@param rBrowseBox The BrowseBox control.
@param eNameText The constant for the name text.
@param eDescrText The constant for the description text.
@param rxParent XAccessible interface of the parent object.
@param rBrowseBox The BrowseBox control.
@param _xFocusWindow The window that gets all the focus events.
@param eObjType Object type
*/
BrowseBoxAccessibleElement(
const css::uno::Reference<
css::accessibility::XAccessible >& rxParent,
::svt::IAccessibleTableProvider& rBrowseBox,
const css::uno::Reference< css::accessibility::XAccessible >& rxParent,
::svt::IAccessibleTableProvider& rBrowseBox,
const css::uno::Reference< css::awt::XWindow >& _xFocusWindow,
::svt::AccessibleBrowseBoxObjType eObjType );
::svt::AccessibleBrowseBoxObjType eObjType );
/** Constructor sets specified name and description.
@param rxParent XAccessible interface of the parent object.
@param rBrowseBox The BrowseBox control.
@param rName The name of this object.
@param rDescription The description text of this object.
@param rxParent XAccessible interface of the parent object.
@param rBrowseBox The BrowseBox control.
@param _xFocusWindow The window that gets all the focus events.
@param eObjType Object type
@param rName The name of this object.
@param rDescription The description text of this object.
*/
BrowseBoxAccessibleElement(
const css::uno::Reference<
css::accessibility::XAccessible >& rxParent,
::svt::IAccessibleTableProvider& rBrowseBox,
const css::uno::Reference< css::accessibility::XAccessible >& rxParent,
::svt::IAccessibleTableProvider& rBrowseBox,
const css::uno::Reference< css::awt::XWindow >& _xFocusWindow,
::svt::AccessibleBrowseBoxObjType eObjType,
const OUString& rName,
const OUString& rDescription );
::svt::AccessibleBrowseBoxObjType eObjType,
const OUString& rName,
const OUString& rDescription );
public:
// XInterface
@@ -400,7 +397,7 @@ protected:
virtual ~BrowseBoxAccessibleElement();
protected:
// XAccessible ------------------------------------------------------------
// XAccessible
/** @return The XAccessibleContext interface of this object. */
virtual css::uno::Reference< css::accessibility::XAccessibleContext > SAL_CALL getAccessibleContext()
@@ -424,7 +421,7 @@ public:
}
};
// inlines --------------------------------------------------------------------
// inlines
inline ::svt::AccessibleBrowseBoxObjType AccessibleBrowseBoxBase::getType() const
{

8
accessibility/inc/accessibility/extended/AccessibleBrowseBoxHeaderBar.hxx
View File

@@ -43,12 +43,14 @@ class AccessibleBrowseBoxHeaderBar :
public AccessibleBrowseBoxHeaderBarImplHelper
{
public:
/** @param eObjType One of the two allowed types BBTYPE_ROWHEADERBAR or
/** @param rxParent Parent that holds the browsebox headerbar control
@param rBrowseBox The BrowseBox control.
@param eObjType One of the two allowed types BBTYPE_ROWHEADERBAR or
BBTYPE_COLUMNHEADERBAR. */
AccessibleBrowseBoxHeaderBar(
const css::uno::Reference< css::accessibility::XAccessible >& rxParent,
::svt::IAccessibleTableProvider& rBrowseBox,
::svt::AccessibleBrowseBoxObjType eObjType );
::svt::IAccessibleTableProvider& rBrowseBox,
::svt::AccessibleBrowseBoxObjType eObjType );
protected:
virtual ~AccessibleBrowseBoxHeaderBar();

13
accessibility/inc/accessibility/extended/AccessibleBrowseBoxTableBase.hxx
View File

@@ -46,14 +46,13 @@ public:
implSetName() and implSetDescription() (in Ctor) or later via
setAccessibleName() and setAccessibleDescription() (these methods
notify the listeners about the change).
@param rxParent XAccessible interface of the parent object.
@param rBrowseBox The BrowseBox control.
@param eNameText The constant for the name text.
@param eDescrText The constant for the description text. */
@param rxParent XAccessible interface of the parent object.
@param rBrowseBox The BrowseBox control.
@param eObjType Type of BrowseBox object. */
AccessibleBrowseBoxTableBase(
const css::uno::Reference< css::accessibility::XAccessible >& rxParent,
::svt::IAccessibleTableProvider& rBrowseBox,
::svt::AccessibleBrowseBoxObjType eObjType );
::svt::IAccessibleTableProvider& rBrowseBox,
::svt::AccessibleBrowseBoxObjType eObjType );
protected:
virtual ~AccessibleBrowseBoxTableBase();
@@ -213,10 +212,12 @@ protected:
/** Selects/deselects a row (tries to expand selection).
@attention This method requires locked mutex's and a living object.
@param nRow Row to select
@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 nColumnPos column number to select
@param bSelect TRUE = select, FALSE = deselect */
void implSelectColumn( sal_Int32 nColumnPos, bool bSelect );

14
accessibility/inc/accessibility/extended/AccessibleGridControlBase.hxx
View File

@@ -61,7 +61,7 @@ typedef ::cppu::WeakAggComponentImplHelper4<
/** The GridControl 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 AccessibleGridControlBase :
public ::comphelper::OBaseMutex,
public AccessibleGridControlImplHelper
@@ -69,9 +69,8 @@ class AccessibleGridControlBase :
public:
/** Constructor sets specified name and description.
@param rxParent XAccessible interface of the parent object.
@param rTable The Table control.
@param eNameText The constant for the name text.
@param eDescrText The constant for the description text. */
@param rTable The Table control.
@param eObjType Type of accessible table control. */
AccessibleGridControlBase(
const css::uno::Reference< css::accessibility::XAccessible >& rxParent,
::svt::table::IAccessibleTable& rTable,
@@ -305,10 +304,9 @@ class GridControlAccessibleElement
protected:
/** Constructor sets specified name and description.
@param rxParent XAccessible interface of the parent object.
@param rTable The Table control.
@param eNameText The constant for the name text.
@param eDescrText The constant for the description text.
@param rxParent XAccessible interface of the parent object.
@param rTable The Table control.
@param eObjType Type of table control
*/
GridControlAccessibleElement(
const css::uno::Reference< css::accessibility::XAccessible >& rxParent,

13
accessibility/inc/accessibility/extended/AccessibleGridControlHeader.hxx
View File

@@ -21,16 +21,11 @@
#ifndef INCLUDED_ACCESSIBILITY_INC_ACCESSIBILITY_EXTENDED_ACCESSIBLEGRIDCONTROLHEADER_HXX
#define INCLUDED_ACCESSIBILITY_INC_ACCESSIBILITY_EXTENDED_ACCESSIBLEGRIDCONTROLHEADER_HXX
#include "accessibility/extended/AccessibleGridControlHeaderCell.hxx"
#include "accessibility/extended/AccessibleGridControlTableBase.hxx"
#include <accessibility/extended/AccessibleGridControlHeaderCell.hxx>
#include <accessibility/extended/AccessibleGridControlTableBase.hxx>
namespace accessibility {
/** This class represents the accessible object of a header bar of a Grid Control
(row or column header bar). This object supports the
XAccessibleSelection interface. Selecting a child of this object selects
@@ -38,7 +33,9 @@ namespace accessibility {
class AccessibleGridControlHeader : public AccessibleGridControlTableBase
{
public:
/** @param eObjType One of the two allowed types TCTYPE_ROWHEADERBAR or
/** @param rxParent accessible parent control
@param rTable accessible table
@param eObjType One of the two allowed types TCTYPE_ROWHEADERBAR or
TCTYPE_COLUMNHEADERBAR. */
AccessibleGridControlHeader(
const css::uno::Reference<

17
accessibility/inc/accessibility/extended/AccessibleGridControlTableBase.hxx
View File

@@ -43,9 +43,8 @@ class AccessibleGridControlTableBase :
public:
/** Constructor sets specified name and description.
@param rxParent XAccessible interface of the parent object.
@param rTable The Table control.
@param eNameText The constant for the name text.
@param eDescrText The constant for the description text. */
@param rTable The Table control.
@param eObjType Type of table control object */
AccessibleGridControlTableBase(
const css::uno::Reference< css::accessibility::XAccessible >& rxParent,
::svt::table::IAccessibleTable& rTable,
@@ -55,7 +54,7 @@ protected:
virtual ~AccessibleGridControlTableBase();
public:
// XAccessibleContext -----------------------------------------------------
// XAccessibleContext
/** @return The count of visible children. */
virtual sal_Int32 SAL_CALL getAccessibleChildCount()
@@ -69,13 +68,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()
@@ -134,7 +133,7 @@ public:
- getAccessibleCellAt,
- isAccessibleSelected. */
// XInterface -------------------------------------------------------------
// XInterface
/** Queries for a new interface. */
css::uno::Any SAL_CALL queryInterface( const css::uno::Type& rType )
@@ -146,7 +145,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()
@@ -157,7 +156,7 @@ public:
throw ( css::uno::RuntimeException, std::exception ) override;
protected:
// internal helper methods ------------------------------------------------
// internal helper methods
/** @attention This method requires locked mutex's and a living object.
@return The number of cells of the table. */

9
accessibility/inc/accessibility/extended/accessibleiconchoicectrlentry.hxx
View File

@@ -42,7 +42,6 @@
class SvxIconChoiceCtrlEntry;
class SvtIconChoiceCtrl;
namespace accessibility
{
@@ -100,10 +99,10 @@ namespace accessibility
public:
/** Ctor()
@param _rListBox
the view control
@param _pEntry
the entry
@param _rIconCtrl
the icon control
@param _nPos
the entry number
@param _xParent
is our parent accessible object
*/

2
solenv/bin/mkdocs.sh
View File

@@ -221,7 +221,7 @@ for module_name in *; do
text="<p><b>View module in:</b>"
text="${text} &nbsp; <a href=\"http://cgit.freedesktop.org/libreoffice/core/tree/${module_name}\">cgit</a>"
if $(echo $INPUT_PROJECTS | grep -q $module_name); then
text="${text} &nbsp; <a href=\"${module_name}/html/classes.html\">Doxygen</a>"
text="${text} &nbsp; <a href=\"${module_name}/html/classes.xhtml\">Doxygen</a>"
fi
text="${text} </p><p>&nbsp;</p>"
echo -e $text >> "$BASE_OUTPUT/${module_name}.html"

6
solenv/inc/doxygen.cfg
View File

@@ -1052,7 +1052,7 @@ HTML_OUTPUT =
# The default value is: .html.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_FILE_EXTENSION = .html
HTML_FILE_EXTENSION = .xhtml
# The HTML_HEADER tag can be used to specify a user-defined HTML header file for
# each generated HTML page. If the tag is left blank doxygen will generate a
@@ -2292,7 +2292,7 @@ DIRECTORY_GRAPH = YES
# The default value is: png.
# This tag requires that the tag HAVE_DOT is set to YES.
DOT_IMAGE_FORMAT = gif
DOT_IMAGE_FORMAT = svg
# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
# enable generation of interactive SVG images that allow zooming and panning.
@@ -2304,7 +2304,7 @@ DOT_IMAGE_FORMAT = gif
# The default value is: NO.
# This tag requires that the tag HAVE_DOT is set to YES.
INTERACTIVE_SVG = NO
INTERACTIVE_SVG = YES
# The DOT_PATH tag can be used to specify the path where the dot tool can be
# found. If left blank, it is assumed the dot tool can be found in the path.