docs: tree wide enum sentinel value documentation

This commit is contained in:
Stefan Schmidt 2016-10-24 20:33:26 +02:00
parent ef814db490
commit 7df301d857
5 changed files with 13 additions and 13 deletions

View File

@ -23,7 +23,7 @@ enum Efl.Gfx.Colorspace {
enum Efl.Gfx.Render_Op { enum Efl.Gfx.Render_Op {
blend = 0, [[Alpha blending onto destination (default); d = d*(1-sa) + s.]] blend = 0, [[Alpha blending onto destination (default); d = d*(1-sa) + s.]]
copy = 1, [[Copy source to destination; d = s.]] copy = 1, [[Copy source to destination; d = s.]]
last last [[Sentinel value to indicate last enum field during iteration]]
} }
enum Efl.Gfx.Path.Command_Type { enum Efl.Gfx.Path.Command_Type {
@ -35,7 +35,7 @@ enum Efl.Gfx.Path.Command_Type {
line_to, [[The next point is used to draw a line from current point.]] line_to, [[The next point is used to draw a line from current point.]]
cubic_to, [[The next three point is used to draw a cubic bezier curve from current point.]] cubic_to, [[The next three point is used to draw a cubic bezier curve from current point.]]
close, [[Close the curent subpath by drawing a line between current point and the first point of current subpath.]] close, [[Close the curent subpath by drawing a line between current point and the first point of current subpath.]]
last [[Not a valid command, but last one according to this version header.]] last [[Sentinel value to indicate last enum field during iteration]]
} }
enum Efl.Gfx.Cap { enum Efl.Gfx.Cap {
@ -47,7 +47,7 @@ enum Efl.Gfx.Cap {
butt = 0, [[The end of lines is rendered as a full stop on the last point itself.]] butt = 0, [[The end of lines is rendered as a full stop on the last point itself.]]
round, [[The end of lines is rendered as a half-circle around the last point.]] round, [[The end of lines is rendered as a half-circle around the last point.]]
square, [[The end of lines is rendered as a square around the last point.]] square, [[The end of lines is rendered as a square around the last point.]]
last [[End of enum value.]] last [[Sentinel value to indicate last enum field during iteration]]
} }
enum Efl.Gfx.Join enum Efl.Gfx.Join
@ -59,7 +59,7 @@ enum Efl.Gfx.Join
miter = 0, [[Used to render rounded line joins. Circular arcs are used to join two lines smoothly.]] miter = 0, [[Used to render rounded line joins. Circular arcs are used to join two lines smoothly.]]
round, [[Used to render beveled line joins. The outer corner of the joined lines is filled by enclosing the triangular region of the corner with a straight line between the outer corners of each stroke.]] round, [[Used to render beveled line joins. The outer corner of the joined lines is filled by enclosing the triangular region of the corner with a straight line between the outer corners of each stroke.]]
bevel, [[Used to render mitered line joins. The intersection of the strokes is clipped at a line perpendicular to the bisector of the angle between the strokes, at the distance from the intersection of the segments equal to the product of the miter limit value and the border radius. This prevents long spikes being created.]] bevel, [[Used to render mitered line joins. The intersection of the strokes is clipped at a line perpendicular to the bisector of the angle between the strokes, at the distance from the intersection of the segments equal to the product of the miter limit value and the border radius. This prevents long spikes being created.]]
last [[End of enum value]] last [[Sentinel value to indicate last enum field during iteration]]
} }
enum Efl.Gfx.Gradient.Spread enum Efl.Gfx.Gradient.Spread
@ -71,7 +71,7 @@ enum Efl.Gfx.Gradient.Spread
pad, [[The area is filled with the closest stop color. This is the default.]] pad, [[The area is filled with the closest stop color. This is the default.]]
reflect, [[The gradient is reflected outside the gradient area.]] reflect, [[The gradient is reflected outside the gradient area.]]
repeat, [[The gradient is repeated outside the gradient area.]] repeat, [[The gradient is repeated outside the gradient area.]]
last [[End of enum value]] last [[Sentinel value to indicate last enum field during iteration]]
} }
enum Efl.Gfx.Fill.Rule enum Efl.Gfx.Fill.Rule

View File

@ -16,7 +16,7 @@ enum Elm.Gesture.Type
n_flicks, [[N fingers flick gesture]] n_flicks, [[N fingers flick gesture]]
zoom, [[Zoom]] zoom, [[Zoom]]
rotate, [[Rotate]] rotate, [[Rotate]]
last last [[Sentinel value to indicate last enum field during iteration]]
} }
enum Elm.Gesture.State enum Elm.Gesture.State

View File

@ -14,7 +14,7 @@ enum Elm.Scroller.Policy
auto = 0, [[Show scrollbars as needed]] auto = 0, [[Show scrollbars as needed]]
on, [[Always show scrollbars]] on, [[Always show scrollbars]]
off, [[Never show scrollbars]] off, [[Never show scrollbars]]
last last [[Sentinel value to indicate last enum field during iteration]]
} }
enum Elm.Scroller.Single_Direction enum Elm.Scroller.Single_Direction
@ -26,7 +26,7 @@ enum Elm.Scroller.Single_Direction
none = 0, [[Scroll every direction]] none = 0, [[Scroll every direction]]
soft, [[Scroll single direction if the direction is certain]] soft, [[Scroll single direction if the direction is certain]]
hard, [[Scroll only single direction]] hard, [[Scroll only single direction]]
last last [[Sentinel value to indicate last enum field during iteration]]
} }
enum Elm.Scroller.Movement_Block enum Elm.Scroller.Movement_Block

View File

@ -24,7 +24,7 @@ enum Elm.Map.Zoom_Mode
manual, [[Zoom controlled manually by elm_map_zoom_set(). It's set by default.]] manual, [[Zoom controlled manually by elm_map_zoom_set(). It's set by default.]]
auto_fit, [[Zoom until map fits inside the scroll frame with no pixels outside this area.]] auto_fit, [[Zoom until map fits inside the scroll frame with no pixels outside this area.]]
auto_fill, [[Zoom until map fills scroll, ensuring no pixels are left unfilled.]] auto_fill, [[Zoom until map fills scroll, ensuring no pixels are left unfilled.]]
last last [[Sentinel value to indicate last enum field during iteration]]
} }
enum Elm.Map.Source_Type enum Elm.Map.Source_Type
@ -39,7 +39,7 @@ enum Elm.Map.Source_Type
tile, [[Map tile provider.]] tile, [[Map tile provider.]]
route, [[Route service provider.]] route, [[Route service provider.]]
name, [[Name service provider.]] name, [[Name service provider.]]
last last [[Sentinel value to indicate last enum field during iteration]]
} }
enum Elm.Map.Route_Type enum Elm.Map.Route_Type
@ -52,7 +52,7 @@ enum Elm.Map.Route_Type
motocar, [[Route should consider an automobile will be used.]] motocar, [[Route should consider an automobile will be used.]]
bicycle, [[Route should consider a bicycle will be used by the user.]] bicycle, [[Route should consider a bicycle will be used by the user.]]
foot, [[Route should consider user will be walking.]] foot, [[Route should consider user will be walking.]]
last last [[Sentinel value to indicate last enum field during iteration]]
} }
@ -65,7 +65,7 @@ enum Elm.Map.Route_Method
]] ]]
fastest, [[Route should prioritize time.]] fastest, [[Route should prioritize time.]]
shortest, [[Route should prioritize distance.]] shortest, [[Route should prioritize distance.]]
last last [[Sentinel value to indicate last enum field during iteration]]
} }

View File

@ -7,7 +7,7 @@ enum Elm.Photocam.Zoom_Mode
auto_fit, [[Zoom until photo fits in photocam]] auto_fit, [[Zoom until photo fits in photocam]]
auto_fill, [[Zoom until photo fills photocam]] auto_fill, [[Zoom until photo fills photocam]]
auto_fit_in, [[Zoom in until photo fits in photocam]] auto_fit_in, [[Zoom in until photo fits in photocam]]
last last [[Sentinel value to indicate last enum field during iteration]]
} }
class Elm.Photocam (Elm.Widget, Elm.Interface_Scrollable, class Elm.Photocam (Elm.Widget, Elm.Interface_Scrollable,