From 8c09c1cae8b4368b88ec0b296f124d35e735dc7e Mon Sep 17 00:00:00 2001 From: Xavi Artigas Date: Fri, 13 Sep 2019 12:25:49 +0200 Subject: 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. --- src/lib/efl/interfaces/efl_text_font.eo | 54 +++++++++++++-------------------- 1 file changed, 21 insertions(+), 33 deletions(-) (limited to 'src/lib/efl/interfaces/efl_text_font.eo') 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 { c_prefix: efl_text; methods { @property font { - set { - [[Set the font family, filename and size for a given text object. + [[The font family, filename and size for a given text object. - This function allows the font name and size of a text object to - be set. The font string has to follow fontconfig's convention for - naming fonts, as it's the underlying library used to query system - fonts by Evas (see the fc-list command's output, on your system, - to get an idea). Alternatively, youe can use the full path to a font - file. + This property controls the font name and size of a text object. + The font string has to follow fontconfig's convention for + naming fonts, as it's the underlying library used to query system + fonts by Evas (see the fc-list command's output, on your system, + to get an idea). Alternatively, youe can use the full path to a font + file. - To skip changing font family pass null as font family. - To skip changing font size pass 0 as font size. + To skip changing font family pass null as font family. + To skip changing font size pass 0 as font size. - See also @.font.get, @.font_source.get. - ]] + When reading it, the font name string is still owned by + Evas and should not be freed. + See also @.font_source. + ]] + set { } get { - [[Retrieve the font family and size in use on a given text object. - - This function allows the font name and size of a text object to - be queried. Remember that the font name string is still owned by - Evas and should not have free() called on it by the caller of the - function. - - See also @.font.set. - ]] } values { font: string; [[The font family name or filename.]] @@ -86,22 +79,17 @@ interface @beta Efl.Text_Font { } } @property font_source { - set { - [[Set the font (source) file to be used on a given text object. + [[The font (source) file to be used on a given text object. - This function allows the font file to be explicitly set for a - given text object, overriding system lookup, which will first - occur in the given file's contents. + This function allows the font file to be explicitly set for a + given text object, overriding system lookup, which will first + occur in the given file's contents. - See also @.font.set. - ]] + See also @.font. + ]] + set { } get { - [[Get the font file's path which is being used on a given text - object. - - See @.font.get for more details. - ]] } values { font_source: string; [[The font file's path.]] -- cgit v1.2.1