Kaydet (Commit) 9739aa9f authored tarafından Michael Stahl's avatar Michael Stahl

offapi: fix more doxygen warnings

Change-Id: I55f4c0388b99cfebe647be1c35a9fd4bb2acf7ce
üst 0ccf596a
...@@ -80,6 +80,9 @@ published interface XFont: com::sun::star::uno::XInterface ...@@ -80,6 +80,9 @@ published interface XFont: com::sun::star::uno::XInterface
the width of the specified string of characters the width of the specified string of characters
measured in pixels for the device. measured in pixels for the device.
@param str
the input string.
@param aDXArray @param aDXArray
receives the width of every single character receives the width of every single character
measured in pixels for the device. measured in pixels for the device.
......
...@@ -55,7 +55,8 @@ interface XSimpleTabController : com::sun::star::uno::XInterface ...@@ -55,7 +55,8 @@ interface XSimpleTabController : com::sun::star::uno::XInterface
/** change some properties of the specified tab. /** change some properties of the specified tab.
Such properties can be: @param Properties
Such properties can be:
<table> <table>
<tr> <tr>
<td><b>Property</b></td> <td><b>Property</b></td>
......
...@@ -62,6 +62,7 @@ published interface XWindowPeer: com::sun::star::lang::XComponent ...@@ -62,6 +62,7 @@ published interface XWindowPeer: com::sun::star::lang::XComponent
/** invalidates a rectangular area of the window with the specified /** invalidates a rectangular area of the window with the specified
InvalidateStyle. InvalidateStyle.
@param Rect the area to invalidate.
@param Flags see com.sun.star.awt.InvalidateStyle @param Flags see com.sun.star.awt.InvalidateStyle
*/ */
void invalidateRect( [in] Rectangle Rect, [in] short Flags ); void invalidateRect( [in] Rectangle Rect, [in] short Flags );
......
...@@ -50,10 +50,12 @@ interface XSortableGridData ...@@ -50,10 +50,12 @@ interface XSortableGridData
/** returns the current sort order. /** returns the current sort order.
@return @return
a structure describing the current sort order. ::com::sun::star::beans::Pair::First a structure describing the current sort order.
denotes the column by which the data is sorted, or -1 if the data is currently unsorted. com::sun::star::beans::Pair::First
::com::sun::star::beans::Pair::Second is `TRUE` if the data is sorted ascending, denotes the column by which the data is sorted, or -1 if
`FALSE` otherwise. the data is currently unsorted.
com::sun::star::beans::Pair::Second
is `TRUE` if the data is sorted ascending, `FALSE` otherwise.
*/ */
::com::sun::star::beans::Pair< long, boolean > ::com::sun::star::beans::Pair< long, boolean >
getCurrentSortOrder(); getCurrentSortOrder();
......
...@@ -45,6 +45,9 @@ interface XMutableTreeNode : XTreeNode ...@@ -45,6 +45,9 @@ interface XMutableTreeNode : XTreeNode
@param Index @param Index
the index where the node will be inserted to this instance. the index where the node will be inserted to this instance.
@param ChildNode
the node to insert.
@throws ::com::sun::star::lang::IllegalArgumentException @throws ::com::sun::star::lang::IllegalArgumentException
if <var>ChildNode</var> is not a valid node of the corresponding XTreeDataModel. if <var>ChildNode</var> is not a valid node of the corresponding XTreeDataModel.
......
...@@ -55,9 +55,10 @@ service Legend ...@@ -55,9 +55,10 @@ service Legend
/** Determines how the aspect ratio of the legend should roughly /** Determines how the aspect ratio of the legend should roughly
be. be.
<p>Set the Expansion to ::com::sun::star::chart::ChartLegendExpansion::HIGH <p>Set the Expansion to
::com::sun::star::chart#HIGH
for a legend that is positioned on the right or left hand for a legend that is positioned on the right or left hand
side. Use LegendExpansion::WIDE for a legend side. Use ::com::sun::star::chart::WIDE for a legend
that is positioned on top or the bottom.</p> that is positioned on top or the bottom.</p>
*/ */
[property] ::com::sun::star::chart::ChartLegendExpansion Expansion; [property] ::com::sun::star::chart::ChartLegendExpansion Expansion;
......
...@@ -94,6 +94,9 @@ interface XChartTypeTemplate : ::com::sun::star::uno::XInterface ...@@ -94,6 +94,9 @@ interface XChartTypeTemplate : ::com::sun::star::uno::XInterface
given diagram should return `TRUE` before this method is given diagram should return `TRUE` before this method is
called.</p> called.</p>
@param xDiagram
The diagram to be changed.
@param xDataSource @param xDataSource
This data source will be interpreted in a chart-type This data source will be interpreted in a chart-type
specific way and the DataSeries found in specific way and the DataSeries found in
......
...@@ -41,6 +41,9 @@ interface XDataInterpreter : ::com::sun::star::uno::XInterface ...@@ -41,6 +41,9 @@ interface XDataInterpreter : ::com::sun::star::uno::XInterface
{ {
/** Interprets the given data. /** Interprets the given data.
@param xSource
the data source.
@param aArguments @param aArguments
Arguments that tell the template how to slice the given Arguments that tell the template how to slice the given
range. The properties should be defined in a separate range. The properties should be defined in a separate
......
...@@ -103,6 +103,11 @@ interface XRegressionCurveCalculator : com::sun::star::uno::XInterface ...@@ -103,6 +103,11 @@ interface XRegressionCurveCalculator : com::sun::star::uno::XInterface
account. When one of these parameters is unknown, no account. When one of these parameters is unknown, no
optimization must be done.</p> optimization must be done.</p>
@param min the abscissa value for the starting point.
@param max the abscissa value for the ending point.
@param nPointCount the number of points to calculate.
@param bMaySkipPointsInCalculation determines whether it is @param bMaySkipPointsInCalculation determines whether it is
allowed to skip points in the calculation. When this allowed to skip points in the calculation. When this
parameter is `TRUE` it is assumed that the underlying parameter is `TRUE` it is assumed that the underlying
......
...@@ -156,6 +156,12 @@ interface XDocumentMetadataAccess ...@@ -156,6 +156,12 @@ interface XDocumentMetadataAccess
</ol> </ol>
</p> </p>
@param Format
the file format, see FileFormat
@param InStream
the input stream
@param FileName @param FileName
the name of the stream in the ODF storage where the graph will the name of the stream in the ODF storage where the graph will
be stored be stored
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment