diff options
author | Kohei Yoshida <kohei.yoshida@collabora.com> | 2014-10-09 10:27:26 -0400 |
---|---|---|
committer | Kohei Yoshida <kohei.yoshida@collabora.com> | 2014-10-09 16:34:20 -0400 |
commit | 7df90ca4ddc3edd2df10a7d74772f0bea28d35c0 (patch) | |
tree | 767423ffec3eb4d83c394de0b9466d55092f7194 /offapi | |
parent | 877b66a00b1d6fe4f8ed2fc61774a240e653b49e (diff) |
Improve method descriptions.
Change-Id: I25074578607dedaec9689dff9a6bb9c2fa7be56b
Diffstat (limited to 'offapi')
-rw-r--r-- | offapi/com/sun/star/chart2/XScaling.idl | 29 |
1 files changed, 20 insertions, 9 deletions
diff --git a/offapi/com/sun/star/chart2/XScaling.idl b/offapi/com/sun/star/chart2/XScaling.idl index 7d65c84c385a..0daf41b0b907 100644 --- a/offapi/com/sun/star/chart2/XScaling.idl +++ b/offapi/com/sun/star/chart2/XScaling.idl @@ -28,16 +28,27 @@ module com { module sun { module star { module chart2 { interface XScaling : ::com::sun::star::uno::XInterface { - /** needs to keep relative ordering - */ - double doScaling([in] double value); + /** + * Given a numeric value, return the scaled value that conforms + * to a predefined scaling rule. For instance, for linear + * scaling, given a x value, the method may return a y value as + * defined by y = Ax + B for predefined values of A and B. + * + * @param value input value from which to calculate the scaled + * value. + * + * @return scaled value based on a predefined scaling rule. + */ + double doScaling( [in] double value ); + + /** + * Get an interface object that conforms to a scaling rule that + * is the reverse of the original scaling rule. + * + * @return internface object that represents the reversed + * scaling rule. + */ com::sun::star::chart2::XScaling getInverseScaling(); - - //maybe provide correction for Min/Max - //double getMinimum(); ?adjust <-> min/max may not exist - //double getMaximum(); - - //... or better/additionally?: provide default values for Min&Max }; |