docs: ector: document generic surface mixin

Leave out the params and returns marked with a FIXME.

diff --git a/src/lib/ector/ector_generic_surface.eo b/src/lib/ector/ector_generic_surface.eo
index b2735ec..db778b9 100644 (file)
--- a/src/lib/ector/ector_generic_surface.eo
+++ b/src/lib/ector/ector_generic_surface.eo
@@ -1,19 +1,22 @@
 mixin Ector.Generic.Surface (Ector.Generic.Buffer)
 {
+   [[Surface interface for Ector]]
+
    eo_prefix: ector_surface;
    legacy_prefix: null;
    data: null;
    methods {
       @property reference_point {
+         [[This define where is (0,0) in pixels coordinate inside the surface]]
          set {
-            [[This define where is (0,0) in pixels coordinate inside the surface]]
          }
          values {
-            x: int;
-            y: int;
+            x: int; [[X coordinate for reference point]]
+            y: int; [[Y coordinate for reference point]]
          }
       }
       renderer_factory_new {
+         [[Create a new renderer factory for the given type]]
          return: Eo.Base *; /* FIXME: Should be a more restricted type, only here for cyclic. */
          params {
             @in type: const(Eo.Abstract_Class) * @nonull; /* FIXME: Should probably be a more restricted type */