summaryrefslogtreecommitdiff
path: root/src/lib/efl/interfaces/efl_text_font.eo
diff options
context:
space:
mode:
authorXavi Artigas <xavierartigas@yahoo.es>2019-09-13 12:25:49 +0200
committerXavi Artigas <xavierartigas@yahoo.es>2019-09-13 12:30:03 +0200
commit8c09c1cae8b4368b88ec0b296f124d35e735dc7e (patch)
tree16548e1c5e3c8ac8b51398525da011ab555d4e29 /src/lib/efl/interfaces/efl_text_font.eo
parent5e9b30153399014ff0aa52922f8460c7769eb741 (diff)
docs: Move property docs to property level instead of set/get
Eolian @properties should be documented at the property level, and documentation at the setter or getter level should be left to setter- or getter-specific comments. There is usually no need at all to have setter- or getter- specific comments. Also, a property is not a method so descriptions should match that. This patch removes lots of duplicated text, and will allow enabling by default the eolian check that ensures that properties have proper property-level docs. No functional changes.
Diffstat (limited to 'src/lib/efl/interfaces/efl_text_font.eo')
-rw-r--r--src/lib/efl/interfaces/efl_text_font.eo54
1 files changed, 21 insertions, 33 deletions
diff --git a/src/lib/efl/interfaces/efl_text_font.eo b/src/lib/efl/interfaces/efl_text_font.eo
index 31ded3e43e..ccd4e33b35 100644
--- a/src/lib/efl/interfaces/efl_text_font.eo
+++ b/src/lib/efl/interfaces/efl_text_font.eo
@@ -53,32 +53,25 @@ interface @beta Efl.Text_Font {
53 c_prefix: efl_text; 53 c_prefix: efl_text;
54 methods { 54 methods {
55 @property font { 55 @property font {
56 set { 56 [[The font family, filename and size for a given text object.
57 [[Set the font family, filename and size for a given text object.
58 57
59 This function allows the font name and size of a text object to 58 This property controls the font name and size of a text object.
60 be set. The font string has to follow fontconfig's convention for 59 The font string has to follow fontconfig's convention for
61 naming fonts, as it's the underlying library used to query system 60 naming fonts, as it's the underlying library used to query system
62 fonts by Evas (see the fc-list command's output, on your system, 61 fonts by Evas (see the fc-list command's output, on your system,
63 to get an idea). Alternatively, youe can use the full path to a font 62 to get an idea). Alternatively, youe can use the full path to a font
64 file. 63 file.
65 64
66 To skip changing font family pass null as font family. 65 To skip changing font family pass null as font family.
67 To skip changing font size pass 0 as font size. 66 To skip changing font size pass 0 as font size.
68 67
69 See also @.font.get, @.font_source.get. 68 When reading it, the font name string is still owned by
70 ]] 69 Evas and should not be freed.
70 See also @.font_source.
71 ]]
72 set {
71 } 73 }
72 get { 74 get {
73 [[Retrieve the font family and size in use on a given text object.
74
75 This function allows the font name and size of a text object to
76 be queried. Remember that the font name string is still owned by
77 Evas and should not have free() called on it by the caller of the
78 function.
79
80 See also @.font.set.
81 ]]
82 } 75 }
83 values { 76 values {
84 font: string; [[The font family name or filename.]] 77 font: string; [[The font family name or filename.]]
@@ -86,22 +79,17 @@ interface @beta Efl.Text_Font {
86 } 79 }
87 } 80 }
88 @property font_source { 81 @property font_source {
89 set { 82 [[The font (source) file to be used on a given text object.
90 [[Set the font (source) file to be used on a given text object.
91 83
92 This function allows the font file to be explicitly set for a 84 This function allows the font file to be explicitly set for a
93 given text object, overriding system lookup, which will first 85 given text object, overriding system lookup, which will first
94 occur in the given file's contents. 86 occur in the given file's contents.
95 87
96 See also @.font.set. 88 See also @.font.
97 ]] 89 ]]
90 set {
98 } 91 }
99 get { 92 get {
100 [[Get the font file's path which is being used on a given text
101 object.
102
103 See @.font.get for more details.
104 ]]
105 } 93 }
106 values { 94 values {
107 font_source: string; [[The font file's path.]] 95 font_source: string; [[The font file's path.]]