[docs] Remove ClutterFixed from the documentation

Now that ClutterFixed has finally gone the way of the Dodo, we can safely remove it from the API reference as well.
2024-11-26 10:00:45 -05:00 · 2009-03-09 17:56:48 +00:00 · 2009-03-09 17:56:48 +00:00 · f1b237b2ec
commit f1b237b2ec
parent bb83bf282d
4 changed files with 30 additions and 113 deletions
--- a/clutter/clutter-behaviour-ellipse.c
+++ b/clutter/clutter-behaviour-ellipse.c
@ -594,8 +594,8 @@ clutter_behaviour_ellipse_new (ClutterAlpha           *alpha,
 * @width: width of the ellipse
 * @height: height of the ellipse
 * @direction: #ClutterRotateDirection of rotation
- * @start: #ClutterFixed angle in degrees at which movement starts
- * @end: #ClutterFixed angle in degrees at which movement ends
+ * @start: #CoglFixed angle in degrees at which movement starts
+ * @end: #CoglFixed angle in degrees at which movement ends
 *
 * Creates a behaviour that drives actors along an elliptical path. This
 * is the fixed point variant of clutter_behaviour_ellipse_new().
@ -819,7 +819,7 @@ clutter_behaviour_ellipse_set_angle_start (ClutterBehaviourEllipse *self,
 /**
 * clutter_behaviour_ellipse_set_angle_startx
 * @self: a #ClutterBehaviourEllipse
- * @angle_start: An angle, as #ClutterFixed, at which movement starts, in
+ * @angle_start: An angle, as #CoglFixed, at which movement starts, in
 * degrees, between 0 and 360.
 *
 * Sets the angle at which movement starts; angles >= 360 degress get clamped
@ -906,7 +906,7 @@ clutter_behaviour_ellipse_set_angle_end (ClutterBehaviourEllipse *self,
 /**
 * clutter_behaviour_ellipse_set_angle_endx
 * @self: a #ClutterBehaviourEllipse
- * @angle_end: angle, as #ClutterFixed, at which movement ends, in degrees,
+ * @angle_end: angle, as #CoglFixed, at which movement ends, in degrees,
 * between 0 and 360.
 *
 * Sets the angle at which movement ends; angles >= 360 degress get clamped
@ -1149,9 +1149,12 @@ clutter_behaviour_ellipse_set_tilt (ClutterBehaviourEllipse *self,
 /**
 * clutter_behaviour_ellipse_set_tiltx
 * @self: a #ClutterBehaviourEllipse
- * @angle_tilt_x: tilt of the elipse in degrees, as #ClutterFixed, around the center in X axis
- * @angle_tilt_y: tilt of the elipse in degrees, as #ClutterFixed, around the center in Y axis
- * @angle_tilt_z: tilt of the elipse in degrees, as #ClutterFixed, around the center in Z axis
+ * @angle_tilt_x: tilt of the elipse in degrees, as #CoglFixed, around
+ *   the center in X axis
+ * @angle_tilt_y: tilt of the elipse in degrees, as #CoglFixed, around
+ *   the center in Y axis
+ * @angle_tilt_z: tilt of the elipse in degrees, as #CoglFixed, around
+ *   the center in Z axis
 *
 * Sets the angle at which the ellipse should be tilted around it's center.
 *
@ -1205,12 +1208,12 @@ clutter_behaviour_ellipse_get_tilt (ClutterBehaviourEllipse *self,
 /**
 * clutter_behaviour_ellipse_get_tiltx
 * @self: a #ClutterBehaviourEllipse
- * @angle_tilt_x: location for tilt of the elipse, as #ClutterFixed, around the
- * center in X axis in degrees, or NULL.
- * @angle_tilt_y: location for tilt of the elipse, as #ClutterFixed, around the
- * center in Y axis in degress, or NULL.
- * @angle_tilt_z: location for tilt of the elipse, as #ClutterFixed, around the
- * center in Z axis in degrees, or NULL.
+ * @angle_tilt_x: location for tilt of the elipse, as #CoglFixed, around
+ *   the center in X axis in degrees, or %NULL.
+ * @angle_tilt_y: location for tilt of the elipse, as #CoglFixed, around
+ *   the center in Y axis in degress, or %NULL.
+ * @angle_tilt_z: location for tilt of the elipse, as #CoglFixed, around
+ *   the center in Z axis in degrees, or %NULL.
 *
 * Gets the tilt of the ellipse around the center in Y axis.
 *
--- a/clutter/clutter-fixed.c
+++ b/clutter/clutter-fixed.c
@ -36,41 +36,6 @@
 #include "clutter-fixed.h"
 #include "clutter-private.h"

-/**
- * SECTION:clutter-fixed
- * @short_description: Fixed Point API
- *
- * Clutter has a fixed point API targeted at platforms without a
- * floating point unit, such as embedded devices. On such platforms
- * this API should be preferred to the floating point one as it does
- * not trigger the slow path of software emulation, relying on integer
- * math for fixed-to-floating and floating-to-fixed conversion.
- *
- * It is no recommened for use on platforms with a floating point unit
- * (eg desktop systems) nor for use in bindings.
- *
- * Basic rules of Fixed Point arithmethic:
- *
- * <itemizedlist>
- *   <listitem>
- *     <para>Two fixed point numbers can be directly added,
- *     subtracted and have their modulus taken.</para>
- *   </listitem>
- *   <listitem>
- *     <para>To add other numerical type to a fixed point number it has to
- *     be first converted to fixed point.</para>
- *   </listitem>
- *   <listitem>
- *     <para>A fixed point number can be directly multiplied or divided by
- *     an integer.</para>
- *   </listitem>
- *   <listitem>
- *     <para>Two fixed point numbers can only be multiplied and divided by the
- *     provided %CLUTTER_FIXED_MUL and %CLUTTER_FIXED_DIV macros.</para>
- *   </listitem>
- * </itemizedlist>
- */
-
 /**
 * clutter_value_set_fixed:
 * @value: a #GValue initialized to %COGL_TYPE_FIXED
@ -197,7 +162,7 @@ clutter_param_fixed_get_type (void)
 * @default_value: default value
 * @flags: flags for the param spec
 *
- * Creates a #GParamSpec for properties using #ClutterFixed values
+ * Creates a #GParamSpec for properties using #CoglFixed values
 *
 * Return value: the newly created #GParamSpec
 *
--- a/doc/reference/clutter/clutter-docs.xml
+++ b/doc/reference/clutter/clutter-docs.xml
@ -124,7 +124,6 @@
      <xi:include href="xml/clutter-color.xml"/>
      <xi:include href="xml/clutter-binding-pool.xml"/>
      <xi:include href="xml/clutter-event.xml"/>
-      <xi:include href="xml/clutter-fixed.xml"/>
      <xi:include href="xml/clutter-main.xml"/>
      <xi:include href="xml/clutter-shader.xml"/>
      <xi:include href="xml/clutter-units.xml"/>
--- a/doc/reference/clutter/clutter-sections.txt
+++ b/doc/reference/clutter/clutter-sections.txt
@ -856,8 +856,21 @@ clutter_timeout_pool_remove
 clutter_frame_source_add
 clutter_frame_source_add_full

+<SUBSECTION>
+ClutterParamSpecFixed
+clutter_param_spec_fixed
+CLUTTER_VALUE_HOLDS_FIXED
+clutter_value_set_fixed
+clutter_value_get_fixed
+
 <SUBSECTION Standard>
 ClutterTimeoutPool
+
+<SUBSECTION Private>
+CLUTTER_TYPE_PARAM_FIXED
+CLUTTER_PARAM_SPEC_FIXED
+CLUTTER_IS_PARAM_SPEC_FIXED
+clutter_param_fixed_get_type
 </SECTION>

 <SECTION>
@ -868,69 +881,6 @@ clutter_feature_available
 clutter_feature_get_all
 </SECTION>

-<SECTION>
-<FILE>clutter-fixed</FILE>
-<TITLE>Fixed Point Support</TITLE>
-ClutterFixed
-CFX_ONE
-CFX_HALF
-CFX_MAX
-CFX_MIN
-CFX_PI
-CFX_2PI
-CFX_PI_2
-CFX_PI_4
-CFX_120
-CFX_180
-CFX_240
-CFX_360
-CFX_60
-CFX_255
-CLUTTER_FIXED_TO_INT
-CLUTTER_FIXED_TO_FLOAT
-CLUTTER_FIXED_TO_DOUBLE
-CLUTTER_FLOAT_TO_FIXED
-CLUTTER_FLOAT_TO_INT
-CLUTTER_FLOAT_TO_UINT
-CLUTTER_INT_TO_FIXED
-CLUTTER_FIXED_FRACTION
-CLUTTER_FIXED_FLOOR
-CLUTTER_FIXED_CEIL
-CLUTTER_FIXED_MUL
-CLUTTER_FIXED_DIV
-ClutterAngle
-CLUTTER_ANGLE_FROM_DEG
-CLUTTER_ANGLE_FROM_DEGX
-CLUTTER_ANGLE_TO_DEG
-CLUTTER_ANGLE_TO_DEGX
-CLUTTER_ANGLE_MAX_DEG
-CFX_RADIANS_TO_DEGREES
-clutter_cosx
-clutter_sinx
-clutter_tanx
-clutter_atanx
-clutter_atan2x
-clutter_qmulx
-clutter_qdivx
-
-<SUBSECTION>
-CLUTTER_MAXFIXED
-CLUTTER_MINFIXED
-ClutterParamSpecFixed
-clutter_param_spec_fixed
-CLUTTER_VALUE_HOLDS_FIXED
-clutter_value_set_fixed
-clutter_value_get_fixed
-
-<SUBSECTION Private>
-CLUTTER_TYPE_FIXED
-CLUTTER_TYPE_PARAM_FIXED
-CLUTTER_PARAM_SPEC_FIXED
-CLUTTER_IS_PARAM_SPEC_FIXED
-clutter_fixed_get_type
-clutter_param_fixed_get_type
-</SECTION>
-
 <SECTION>
 <FILE>clutter-color</FILE>
 <TITLE>Colors</TITLE>