summaryrefslogtreecommitdiff
path: root/pango/pangofc-font.c
diff options
context:
space:
mode:
authorMatthias Clasen <mclasen@redhat.com>2021-02-15 01:19:43 -0500
committerMatthias Clasen <mclasen@redhat.com>2021-03-11 13:17:36 -0500
commit6aa38752f9a8b5cbe39439d689bdb1ede9ee0a77 (patch)
tree9f8570da771c0ae1ab4354c7ef37bda78c167408 /pango/pangofc-font.c
parentb960d8b61b855a74b2f9078a49c74d2acd657bb0 (diff)
downloadpango-6aa38752f9a8b5cbe39439d689bdb1ede9ee0a77.tar.gz
docs: Port PangoFc apis to the new doc format
Replace gtk-doc'isms and use gi-docgen links instead. Cross-gir links are still an open issue.
Diffstat (limited to 'pango/pangofc-font.c')
-rw-r--r--pango/pangofc-font.c66
1 files changed, 37 insertions, 29 deletions
diff --git a/pango/pangofc-font.c b/pango/pangofc-font.c
index d4488531..d8616537 100644
--- a/pango/pangofc-font.c
+++ b/pango/pangofc-font.c
@@ -25,7 +25,7 @@
* @title:PangoFcFont
* @see_also: #PangoFcFontMap
*
- * #PangoFcFont is a base class for font implementation using the
+ * `PangoFcFont` is a base class for font implementation using the
* Fontconfig and FreeType libraries. It is used in the Xft and
* FreeType backends shipped with Pango, but can also be used when
* creating new backends. Any backend deriving from this base class
@@ -111,12 +111,23 @@ pango_fc_font_class_init (PangoFcFontClass *class)
font_class->create_hb_font = pango_fc_font_create_hb_font;
font_class->get_features = pango_fc_font_get_features;
+ /**
+ * PangoFcFont:pattern:
+ *
+ * The fontconfig pattern for this font.
+ */
g_object_class_install_property (object_class, PROP_PATTERN,
g_param_spec_pointer ("pattern",
"Pattern",
"The fontconfig pattern for this font",
G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY |
G_PARAM_STATIC_STRINGS));
+
+ /**
+ * PangoFcFont:fontmap:
+ *
+ * The PangoFc font map this font is associated with.
+ */
g_object_class_install_property (object_class, PROP_FONTMAP,
g_param_spec_object ("fontmap",
"Font Map",
@@ -529,17 +540,17 @@ pango_fc_font_real_get_glyph (PangoFcFont *font,
/**
* pango_fc_font_lock_face: (skip)
- * @font: a #PangoFcFont.
+ * @font: a `PangoFcFont`.
*
* Gets the FreeType `FT_Face` associated with a font,
* This face will be kept around until you call
- * pango_fc_font_unlock_face().
+ * [method@PangoFc.Font.unlock_face].
*
* Return value: the FreeType `FT_Face` associated with @font.
*
* Since: 1.4
* Deprecated: 1.44: Use pango_font_get_hb_font() instead
- **/
+ */
FT_Face
pango_fc_font_lock_face (PangoFcFont *font)
{
@@ -550,14 +561,14 @@ pango_fc_font_lock_face (PangoFcFont *font)
/**
* pango_fc_font_unlock_face:
- * @font: a #PangoFcFont.
+ * @font: a `PangoFcFont`.
*
* Releases a font previously obtained with
- * pango_fc_font_lock_face().
+ * [method@PangoFc.Font.lock_face].
*
* Since: 1.4
* Deprecated: 1.44: Use pango_font_get_hb_font() instead
- **/
+ */
void
pango_fc_font_unlock_face (PangoFcFont *font)
{
@@ -577,7 +588,7 @@ pango_fc_font_unlock_face (PangoFcFont *font)
*
* Since: 1.4
* Deprecated: 1.44: Use pango_font_has_char()
- **/
+ */
gboolean
pango_fc_font_has_char (PangoFcFont *font,
gunichar wc)
@@ -602,14 +613,14 @@ pango_fc_font_has_char (PangoFcFont *font,
* @wc: Unicode character to look up
*
* Gets the glyph index for a given Unicode character
- * for @font. If you only want to determine
- * whether the font has the glyph, use pango_fc_font_has_char().
+ * for @font. If you only want to determine whether the
+ * font has the glyph, use [method@PangoFc.Font.has_char].
*
* Return value: the glyph index, or 0, if the Unicode
* character doesn't exist in the font.
*
* Since: 1.4
- **/
+ */
PangoGlyph
pango_fc_font_get_glyph (PangoFcFont *font,
gunichar wc)
@@ -642,7 +653,7 @@ pango_fc_font_get_glyph (PangoFcFont *font,
* Return value: a glyph index into @font.
*
* Since: 1.4
- **/
+ */
PangoGlyph
pango_fc_font_get_unknown_glyph (PangoFcFont *font,
gunichar wc)
@@ -665,17 +676,16 @@ _pango_fc_font_shutdown (PangoFcFont *font)
/**
* pango_fc_font_kern_glyphs:
* @font: a #PangoFcFont
- * @glyphs: a #PangoGlyphString
+ * @glyphs: a `PangoGlyphString`
*
* This function used to adjust each adjacent pair of glyphs
* in @glyphs according to kerning information in @font.
*
* Since 1.44, it does nothing.
*
- *
* Since: 1.4
* Deprecated: 1.32
- **/
+ */
void
pango_fc_font_kern_glyphs (PangoFcFont *font,
PangoGlyphString *glyphs)
@@ -684,15 +694,14 @@ pango_fc_font_kern_glyphs (PangoFcFont *font,
/**
* _pango_fc_font_get_decoder:
- * @font: a #PangoFcFont
+ * @font: a `PangoFcFont`
*
* This will return any custom decoder set on this font.
*
* Return value: The custom decoder
*
* Since: 1.6
- **/
-
+ */
PangoFcDecoder *
_pango_fc_font_get_decoder (PangoFcFont *font)
{
@@ -703,15 +712,14 @@ _pango_fc_font_get_decoder (PangoFcFont *font)
/**
* _pango_fc_font_set_decoder:
- * @font: a #PangoFcFont
- * @decoder: a #PangoFcDecoder to set for this font
+ * @font: a `PangoFcFont`
+ * @decoder: a `PangoFcDecoder` to set for this font
*
- * This sets a custom decoder for this font. Any previous decoder
- * will be released before this one is set.
+ * This sets a custom decoder for this font.
+ * Any previous decoder will be released before this one is set.
*
* Since: 1.6
- **/
-
+ */
void
_pango_fc_font_set_decoder (PangoFcFont *font,
PangoFcDecoder *decoder)
@@ -746,7 +754,7 @@ _pango_fc_font_set_font_key (PangoFcFont *fcfont,
/**
* pango_fc_font_get_raw_extents:
- * @fcfont: a #PangoFcFont
+ * @fcfont: a `PangoFcFont`
* @glyph: the glyph index to load
* @ink_rect: (out) (optional): location to store ink extents of the
* glyph, or %NULL
@@ -764,7 +772,7 @@ _pango_fc_font_set_font_key (PangoFcFont *fcfont,
* caching functionality similar to pango_ft2_font_set_glyph_info().
*
* Since: 1.6
- **/
+ */
void
pango_fc_font_get_raw_extents (PangoFcFont *fcfont,
PangoGlyph glyph,
@@ -1033,7 +1041,7 @@ done:
/**
* pango_fc_font_get_languages:
- * @font: a #PangoFcFont
+ * @font: a `PangoFcFont`
*
* Returns the languages that are supported by @font.
*
@@ -1043,7 +1051,7 @@ done:
* and its fontmap are valid.
*
* Returns: (transfer none) (nullable): a %NULL-terminated
- * array of PangoLanguage*
+ * array of `PangoLanguage`*
*
* Since: 1.48
*/
@@ -1065,7 +1073,7 @@ pango_fc_font_get_languages (PangoFcFont *font)
/**
* pango_fc_font_get_pattern: (skip)
- * @font: a #PangoFcFont
+ * @font: a `PangoFcFont`
*
* Returns the FcPattern that @font is based on.
*