diff options
author | Campbell Barton <ideasman42@gmail.com> | 2021-12-07 09:19:15 +0300 |
---|---|---|
committer | Campbell Barton <ideasman42@gmail.com> | 2021-12-07 09:38:48 +0300 |
commit | ffc4c126f5416b04a01653e7a03451797b98aba4 (patch) | |
tree | ac63d70d33aae5ab1666c9c2f62058c9c1eebd5c /source/blender/blenkernel/BKE_vfontdata.h | |
parent | f159d49f56cedccd509ee93f5a5fb51f4f39eeb8 (diff) |
Cleanup: move public doc-strings into headers for 'blenkernel'
- Added space below non doc-string comments to make it clear
these aren't comments for the symbols directly below them.
- Use doxy sections for some headers.
- Minor improvements to doc-strings.
Ref T92709
Diffstat (limited to 'source/blender/blenkernel/BKE_vfontdata.h')
-rw-r--r-- | source/blender/blenkernel/BKE_vfontdata.h | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/source/blender/blenkernel/BKE_vfontdata.h b/source/blender/blenkernel/BKE_vfontdata.h index b6e57dad934..692857b0458 100644 --- a/source/blender/blenkernel/BKE_vfontdata.h +++ b/source/blender/blenkernel/BKE_vfontdata.h @@ -49,6 +49,12 @@ typedef struct VChar { float width; } VChar; +/** + * Construct a new #VFontData structure from free-type font data in `pf`. + * + * \param pf: The font data. + * \retval A new #VFontData structure, or NULL if unable to load. + */ VFontData *BKE_vfontdata_from_freetypefont(struct PackedFile *pf); VFontData *BKE_vfontdata_copy(const VFontData *vfont_src, const int flag); |