From: Stefan Schmidt <stefan@osg.samsung.com>
Date: Fri, 22 Apr 2016 08:53:09 +0000 (+0200)
Subject: docs: ector: document generic surface mixin
X-Git-Tag: upstream/1.20.0~6653
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=c2823cfb18cbbb4fc3d49752d634dbf2debf72b6;p=platform%2Fupstream%2Fefl.git

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
--- 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 */