isa/mutter
1
0
Fork 0
mirror of https://github.com/brl/mutter.git synced 2024-09-20 14:35:48 -04:00
Code Issues Packages Projects Releases Wiki Activity

[docs] Improve the Units to and from string conversion

Browse Source 
Make sure to document the conversion to and from strings for ClutterUnits,
with negative examples and with the behaviour for fractionary bits.
This commit is contained in:
Emmanuele Bassi 2009-07-20 20:59:18 +01:00
parent b1d98c25f4
commit eff857bc7f
1 changed files with 18 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
clutter/clutter-units.c
View File

@ -363,7 +363,7 @@ clutter_units_to_pixels (ClutterUnits *units)
*
* |[
* number: [0-9]
* unit_value: <numbers>+
* unit_value: <number>+
* unit_name: px|pt|mm|em
* units: <unit_value> <unit_name>
* ]|
@ -372,12 +372,22 @@ clutter_units_to_pixels (ClutterUnits *units)
*
* |[
* 10 px
* 5 em
* 5.1 em
* 24 pt
* 12.6 mm
* ]|
*
* Return value: %TRUE if the string was successfully parsed
* While these are not:
*
* |[
* 42 cats
* omg!1!ponies
* ]|
*
* <note>If no unit is specified, pixels are assumed.</note>
*
* Return value: %TRUE if the string was successfully parsed,
* and %FALSE otherwise
*
* Since: 1.0
*/
@ -474,7 +484,11 @@ clutter_unit_type_name (ClutterUnitType unit_type)
* Converts @units into a string
*
* See clutter_units_from_string() for the units syntax and for
* examples of outputs
* examples of output
*
* <note>Fractional values are truncated to the second decimal
* position for em and mm, and to the first decimal position for
* typographic points. Pixels are integers.</note>
*
* Return value: a newly allocated string containing the encoded
* #ClutterUnits value. Use g_free() to free the string