walkero
/
harfbuzz
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

[doc] Fix generation of hb_glyph_flags_t docs 

GTK-Doc does not like the empty lines here, and interprets everything
after the first empty line as the description of the enum itself not a
specific member and the generated text makes no sense.

Removing the empty lines makes the text harder to read (both in source
and HTML), but at least it is correctly organized.
This commit is contained in:
Khaled Hosny 2022-01-27 01:57:45 +02:00 committed by Behdad Esfahbod
parent e9cc5f6cdb
commit fa29006bfa
1 changed files with 0 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
src/hb-buffer.h
View File

@ -77,7 +77,6 @@ typedef struct hb_glyph_info_t {
* beginning of the cluster this glyph is part of, * beginning of the cluster this glyph is part of,
* then both sides need to be re-shaped, as the * then both sides need to be re-shaped, as the
* result might be different. * result might be different.
*
* On the flip side, it means that when this * On the flip side, it means that when this
* flag is not present, then it is safe to break * flag is not present, then it is safe to break
* the glyph-run at the beginning of this * the glyph-run at the beginning of this
@ -85,21 +84,17 @@ typedef struct hb_glyph_info_t {
* exact same result one would get if breaking * exact same result one would get if breaking
* input text at the beginning of this cluster * input text at the beginning of this cluster
* and shaping the two sides separately. * and shaping the two sides separately.
*
* This can be used to optimize paragraph * This can be used to optimize paragraph
* layout, by avoiding re-shaping of each line * layout, by avoiding re-shaping of each line
* after line-breaking. * after line-breaking.
*
* @HB_GLYPH_FLAG_UNSAFE_TO_CONCAT: Indicates that if input text is changed on one * @HB_GLYPH_FLAG_UNSAFE_TO_CONCAT: Indicates that if input text is changed on one
* side of the beginning of the cluster this glyph * side of the beginning of the cluster this glyph
* is part of, then the shaping results for the * is part of, then the shaping results for the
* other side might change. * other side might change.
*
* Note that the absence of this flag will NOT by * Note that the absence of this flag will NOT by
* itself mean that it IS safe to concat text. * itself mean that it IS safe to concat text.
* Only two pieces of text both of which clear of * Only two pieces of text both of which clear of
* this flag can be concatenated safely. * this flag can be concatenated safely.
*
* This can be used to optimize paragraph * This can be used to optimize paragraph
* layout, by avoiding re-shaping of each line * layout, by avoiding re-shaping of each line
* after line-breaking, by limiting the * after line-breaking, by limiting the
@ -110,7 +105,6 @@ typedef struct hb_glyph_info_t {
* hyphenation or other text transformation * hyphenation or other text transformation
* happens at line-break position, in the following * happens at line-break position, in the following
* way: * way:
*
* 1. Iterate back from the line-break position * 1. Iterate back from the line-break position
* until the first cluster start position that is * until the first cluster start position that is
* NOT unsafe-to-concat, 2. shape the segment from * NOT unsafe-to-concat, 2. shape the segment from
@ -121,7 +115,6 @@ typedef struct hb_glyph_info_t {
* is shaped; If not, move on to a position further * is shaped; If not, move on to a position further
* back that is clear of unsafe-to-concat and retry * back that is clear of unsafe-to-concat and retry
* from there, and repeat. * from there, and repeat.
*
* At the start of next line a similar algorithm can * At the start of next line a similar algorithm can
* be implemented. That is: 1. Iterate forward from * be implemented. That is: 1. Iterate forward from
* the line-break position untill the first cluster * the line-break position untill the first cluster
@ -133,7 +126,6 @@ typedef struct hb_glyph_info_t {
* it into place and the beginning is shaped; If not, * it into place and the beginning is shaped; If not,
* move on to a position further forward that is clear * move on to a position further forward that is clear
* of unsafe-to-concat and retry up to there, and repeat. * of unsafe-to-concat and retry up to there, and repeat.
*
* A slight complication will arise in the * A slight complication will arise in the
* implementation of the algorithm above, * implementation of the algorithm above,
* because while our buffer API has a way to * because while our buffer API has a way to
@ -143,12 +135,9 @@ typedef struct hb_glyph_info_t {
* can be alleviated by shaping more text than needed * can be alleviated by shaping more text than needed
* and looking for unsafe-to-concat flag within text * and looking for unsafe-to-concat flag within text
* clusters. * clusters.
*
* The #HB_GLYPH_FLAG_UNSAFE_TO_BREAK flag will * The #HB_GLYPH_FLAG_UNSAFE_TO_BREAK flag will
* always imply this flag. * always imply this flag.
*
* Since: REPLACEME * Since: REPLACEME
*
* @HB_GLYPH_FLAG_DEFINED: All the currently defined flags. * @HB_GLYPH_FLAG_DEFINED: All the currently defined flags.
* *
* Flags for #hb_glyph_info_t. * Flags for #hb_glyph_info_t.