freetype-commit
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[Git][freetype/freetype][API-organization] API documentation: Re-organiz


From: Werner Lemberg (@wl)
Subject: [Git][freetype/freetype][API-organization] API documentation: Re-organize chapters and sections
Date: Sun, 30 Apr 2023 14:41:52 +0000

Werner Lemberg pushed to branch API-organization at FreeType / FreeType

Commits:

  • 70d00161
    by Werner Lemberg at 2023-04-30T16:41:30+02:00
    API documentation: Re-organize chapters and sections
    
    * Split the very long 'Base Interface' section into smaller sections.
    * Split the 'Core API' chapter into two chapters.
    * Remove single enumeration values from `@order` fields since they have no
      effect.
    

2 changed files:

Changes:

  • include/freetype/freetype.h
    ... ... @@ -102,61 +102,25 @@ FT_BEGIN_HEADER
    102 102
        */
    
    103 103
     
    
    104 104
     
    
    105
    -
    
    106
    -  /*************************************************************************/
    
    107
    -  /*************************************************************************/
    
    108
    -  /*                                                                       */
    
    109
    -  /*                        B A S I C   T Y P E S                          */
    
    110
    -  /*                                                                       */
    
    111
    -  /*************************************************************************/
    
    112
    -  /*************************************************************************/
    
    113
    -
    
    114
    -
    
    115 105
       /**************************************************************************
    
    116 106
        *
    
    117 107
        * @section:
    
    118
    -   *   base_interface
    
    108
    +   *   font_testing_macros
    
    119 109
        *
    
    120 110
        * @title:
    
    121
    -   *   Base Interface
    
    111
    +   *   Font Testing Macros
    
    122 112
        *
    
    123 113
        * @abstract:
    
    124
    -   *   The FreeType~2 base font interface.
    
    114
    +   *   Macros to test various properties of fonts.
    
    125 115
        *
    
    126 116
        * @description:
    
    127
    -   *   This section describes the most important public high-level API
    
    128
    -   *   functions of FreeType~2.
    
    117
    +   *   Macros to test the most important font properties.
    
    129 118
        *
    
    130
    -   * @order:
    
    131
    -   *   FT_Library
    
    132
    -   *   FT_Face
    
    133
    -   *   FT_Size
    
    134
    -   *   FT_GlyphSlot
    
    135
    -   *   FT_CharMap
    
    136
    -   *   FT_Encoding
    
    137
    -   *   FT_ENC_TAG
    
    138
    -   *
    
    139
    -   *   FT_FaceRec
    
    140
    -   *
    
    141
    -   *   FT_FACE_FLAG_SCALABLE
    
    142
    -   *   FT_FACE_FLAG_FIXED_SIZES
    
    143
    -   *   FT_FACE_FLAG_FIXED_WIDTH
    
    144
    -   *   FT_FACE_FLAG_HORIZONTAL
    
    145
    -   *   FT_FACE_FLAG_VERTICAL
    
    146
    -   *   FT_FACE_FLAG_COLOR
    
    147
    -   *   FT_FACE_FLAG_SFNT
    
    148
    -   *   FT_FACE_FLAG_CID_KEYED
    
    149
    -   *   FT_FACE_FLAG_TRICKY
    
    150
    -   *   FT_FACE_FLAG_KERNING
    
    151
    -   *   FT_FACE_FLAG_MULTIPLE_MASTERS
    
    152
    -   *   FT_FACE_FLAG_VARIATION
    
    153
    -   *   FT_FACE_FLAG_GLYPH_NAMES
    
    154
    -   *   FT_FACE_FLAG_EXTERNAL_STREAM
    
    155
    -   *   FT_FACE_FLAG_HINTER
    
    156
    -   *   FT_FACE_FLAG_SVG
    
    157
    -   *   FT_FACE_FLAG_SBIX
    
    158
    -   *   FT_FACE_FLAG_SBIX_OVERLAY
    
    119
    +   *   It is recommended to use these high-level macros instead of directly
    
    120
    +   *   testing the corresponding flags, which are scattered over various
    
    121
    +   *   structures.
    
    159 122
        *
    
    123
    +   * @order:
    
    160 124
        *   FT_HAS_HORIZONTAL
    
    161 125
        *   FT_HAS_VERTICAL
    
    162 126
        *   FT_HAS_KERNING
    
    ... ... @@ -176,21 +140,59 @@ FT_BEGIN_HEADER
    176 140
        *   FT_IS_NAMED_INSTANCE
    
    177 141
        *   FT_IS_VARIATION
    
    178 142
        *
    
    179
    -   *   FT_STYLE_FLAG_BOLD
    
    180
    -   *   FT_STYLE_FLAG_ITALIC
    
    143
    +   */
    
    144
    +
    
    145
    +
    
    146
    +  /**************************************************************************
    
    147
    +   *
    
    148
    +   * @section:
    
    149
    +   *   library_setup
    
    181 150
        *
    
    182
    -   *   FT_SizeRec
    
    183
    -   *   FT_Size_Metrics
    
    151
    +   * @title:
    
    152
    +   *   Library Setup
    
    184 153
        *
    
    185
    -   *   FT_GlyphSlotRec
    
    186
    -   *   FT_Glyph_Metrics
    
    187
    -   *   FT_SubGlyph
    
    154
    +   * @abstract:
    
    155
    +   *   Functions to start and end the usage of the FreeType library.
    
    188 156
        *
    
    189
    -   *   FT_Bitmap_Size
    
    157
    +   * @description:
    
    158
    +   *   Functions to start and end the usage of the FreeType library.
    
    159
    +   *
    
    160
    +   *   Note that @FT_Library_Version and @FREETYPE_XXX are of limited use
    
    161
    +   *   because even a new release of FreeType with only documentation
    
    162
    +   *   changes increases the version number.
    
    190 163
        *
    
    164
    +   * @order:
    
    165
    +   *   FT_Library
    
    191 166
        *   FT_Init_FreeType
    
    192 167
        *   FT_Done_FreeType
    
    193 168
        *
    
    169
    +   *   FT_Library_Version
    
    170
    +   *   FREETYPE_XXX
    
    171
    +   *
    
    172
    +   */
    
    173
    +
    
    174
    +
    
    175
    +  /**************************************************************************
    
    176
    +   *
    
    177
    +   * @section:
    
    178
    +   *   face_creation
    
    179
    +   *
    
    180
    +   * @title:
    
    181
    +   *   Face Creation
    
    182
    +   *
    
    183
    +   * @abstract:
    
    184
    +   *   Functions to manage fonts.
    
    185
    +   *
    
    186
    +   * @description:
    
    187
    +   *   The functions and structures collected in this section operate on
    
    188
    +   *   fonts globally.
    
    189
    +   *
    
    190
    +   * @order:
    
    191
    +   *   FT_Face
    
    192
    +   *   FT_FaceRec
    
    193
    +   *   FT_FACE_FLAG_XXX
    
    194
    +   *   FT_STYLE_FLAG_XXX
    
    195
    +   *
    
    194 196
        *   FT_New_Face
    
    195 197
        *   FT_Done_Face
    
    196 198
        *   FT_Reference_Face
    
    ... ... @@ -198,10 +200,36 @@ FT_BEGIN_HEADER
    198 200
        *   FT_Face_Properties
    
    199 201
        *   FT_Open_Face
    
    200 202
        *   FT_Open_Args
    
    203
    +   *   FT_OPEN_XXX
    
    201 204
        *   FT_Parameter
    
    202 205
        *   FT_Attach_File
    
    203 206
        *   FT_Attach_Stream
    
    204 207
        *
    
    208
    +   */
    
    209
    +
    
    210
    +
    
    211
    +  /**************************************************************************
    
    212
    +   *
    
    213
    +   * @section:
    
    214
    +   *   sizing_and_scaling
    
    215
    +   *
    
    216
    +   * @title:
    
    217
    +   *   Sizing and Scaling
    
    218
    +   *
    
    219
    +   * @abstract:
    
    220
    +   *   Functions to manage font sizes.
    
    221
    +   *
    
    222
    +   * @description:
    
    223
    +   *   The functions and structures collected in this section are related to
    
    224
    +   *   selecting and manipulating the size of a font globally.
    
    225
    +   *
    
    226
    +   * @order:
    
    227
    +   *   FT_Size
    
    228
    +   *   FT_SizeRec
    
    229
    +   *   FT_Size_Metrics
    
    230
    +   *
    
    231
    +   *   FT_Bitmap_Size
    
    232
    +   *
    
    205 233
        *   FT_Set_Char_Size
    
    206 234
        *   FT_Set_Pixel_Sizes
    
    207 235
        *   FT_Request_Size
    
    ... ... @@ -209,44 +237,37 @@ FT_BEGIN_HEADER
    209 237
        *   FT_Size_Request_Type
    
    210 238
        *   FT_Size_RequestRec
    
    211 239
        *   FT_Size_Request
    
    240
    +   *
    
    212 241
        *   FT_Set_Transform
    
    213 242
        *   FT_Get_Transform
    
    214
    -   *   FT_Load_Glyph
    
    215
    -   *   FT_Get_Char_Index
    
    216
    -   *   FT_Get_First_Char
    
    217
    -   *   FT_Get_Next_Char
    
    218
    -   *   FT_Load_Char
    
    219 243
        *
    
    220
    -   *   FT_OPEN_MEMORY
    
    221
    -   *   FT_OPEN_STREAM
    
    222
    -   *   FT_OPEN_PATHNAME
    
    223
    -   *   FT_OPEN_DRIVER
    
    224
    -   *   FT_OPEN_PARAMS
    
    225
    -   *
    
    226
    -   *   FT_LOAD_DEFAULT
    
    227
    -   *   FT_LOAD_RENDER
    
    228
    -   *   FT_LOAD_MONOCHROME
    
    229
    -   *   FT_LOAD_LINEAR_DESIGN
    
    230
    -   *   FT_LOAD_NO_SCALE
    
    231
    -   *   FT_LOAD_NO_HINTING
    
    232
    -   *   FT_LOAD_NO_BITMAP
    
    233
    -   *   FT_LOAD_SBITS_ONLY
    
    234
    -   *   FT_LOAD_NO_AUTOHINT
    
    235
    -   *   FT_LOAD_COLOR
    
    236
    -   *
    
    237
    -   *   FT_LOAD_VERTICAL_LAYOUT
    
    238
    -   *   FT_LOAD_IGNORE_TRANSFORM
    
    239
    -   *   FT_LOAD_FORCE_AUTOHINT
    
    240
    -   *   FT_LOAD_NO_RECURSE
    
    241
    -   *   FT_LOAD_PEDANTIC
    
    242
    -   *
    
    243
    -   *   FT_LOAD_TARGET_NORMAL
    
    244
    -   *   FT_LOAD_TARGET_LIGHT
    
    245
    -   *   FT_LOAD_TARGET_MONO
    
    246
    -   *   FT_LOAD_TARGET_LCD
    
    247
    -   *   FT_LOAD_TARGET_LCD_V
    
    244
    +   */
    
    245
    +
    
    246
    +
    
    247
    +  /**************************************************************************
    
    248
    +   *
    
    249
    +   * @section:
    
    250
    +   *   glyph_retrieval
    
    251
    +   *
    
    252
    +   * @title:
    
    253
    +   *   Glyph Retrieval
    
    254
    +   *
    
    255
    +   * @abstract:
    
    256
    +   *   Functions to manage glyphs.
    
    257
    +   *
    
    258
    +   * @description:
    
    259
    +   *   The functions and structures collected in this section operate on
    
    260
    +   *   single glyphs, of which @FT_Load_Glyph is most important.
    
    248 261
        *
    
    262
    +   * @order:
    
    263
    +   *   FT_GlyphSlot
    
    264
    +   *   FT_GlyphSlotRec
    
    265
    +   *   FT_Glyph_Metrics
    
    266
    +   *
    
    267
    +   *   FT_Load_Glyph
    
    268
    +   *   FT_LOAD_XXX
    
    249 269
        *   FT_LOAD_TARGET_MODE
    
    270
    +   *   FT_LOAD_TARGET_XXX
    
    250 271
        *
    
    251 272
        *   FT_Render_Glyph
    
    252 273
        *   FT_Render_Mode
    
    ... ... @@ -254,34 +275,121 @@ FT_BEGIN_HEADER
    254 275
        *   FT_Kerning_Mode
    
    255 276
        *   FT_Get_Track_Kerning
    
    256 277
        *
    
    278
    +   */
    
    279
    +
    
    280
    +
    
    281
    +  /**************************************************************************
    
    282
    +   *
    
    283
    +   * @section:
    
    284
    +   *   character_mapping
    
    285
    +   *
    
    286
    +   * @title:
    
    287
    +   *   Character Mapping
    
    288
    +   *
    
    289
    +   * @abstract:
    
    290
    +   *   Functions to manage character-to-glyph maps.
    
    291
    +   *
    
    292
    +   * @description:
    
    293
    +   *   This section holds functions and structures that are related to
    
    294
    +   *   mapping character input codes to glyph indices.
    
    295
    +   *
    
    296
    +   *   Note that for many scripts the simplistic approach used by FreeType
    
    297
    +   *   of mapping a single character to a single glyph is not valid or
    
    298
    +   *   possible!  In general, a higher-level library like HarfBuzz or ICU
    
    299
    +   *   should be used for handling text strings.
    
    300
    +   *
    
    301
    +   * @order:
    
    302
    +   *   FT_CharMap
    
    257 303
        *   FT_CharMapRec
    
    304
    +   *   FT_Encoding
    
    305
    +   *   FT_ENC_TAG
    
    306
    +   *
    
    258 307
        *   FT_Select_Charmap
    
    259 308
        *   FT_Set_Charmap
    
    260 309
        *   FT_Get_Charmap_Index
    
    261 310
        *
    
    311
    +   *   FT_Get_Char_Index
    
    312
    +   *   FT_Get_First_Char
    
    313
    +   *   FT_Get_Next_Char
    
    314
    +   *   FT_Load_Char
    
    315
    +   *
    
    316
    +   */
    
    317
    +
    
    318
    +
    
    319
    +  /**************************************************************************
    
    320
    +   *
    
    321
    +   * @section:
    
    322
    +   *   information_retrieval
    
    323
    +   *
    
    324
    +   * @title:
    
    325
    +   *   Information Retrieval
    
    326
    +   *
    
    327
    +   * @abstract:
    
    328
    +   *   Functions to retrieve font and glyph information.
    
    329
    +   *
    
    330
    +   * @description:
    
    331
    +   *   Functions to retrieve font and glyph information.  Only some very
    
    332
    +   *   basic data is covered; see also the chapter on the format-specific
    
    333
    +   *   API for more.
    
    334
    +   *
    
    335
    +   *
    
    336
    +   * @order:
    
    262 337
        *   FT_Get_Name_Index
    
    263 338
        *   FT_Get_Glyph_Name
    
    264 339
        *   FT_Get_Postscript_Name
    
    265 340
        *   FT_Get_FSType_Flags
    
    341
    +   *   FT_FSTYPE_XXX
    
    266 342
        *   FT_Get_SubGlyph_Info
    
    343
    +   *   FT_SUBGLYPH_FLAG_XXX
    
    344
    +   *
    
    345
    +   */
    
    346
    +
    
    347
    +
    
    348
    +  /**************************************************************************
    
    349
    +   *
    
    350
    +   * @section:
    
    351
    +   *   other_api_data
    
    352
    +   *
    
    353
    +   * @title:
    
    354
    +   *   Other API Data
    
    355
    +   *
    
    356
    +   * @abstract:
    
    357
    +   *   Other structures, enumerations, and macros.
    
    267 358
        *
    
    359
    +   * @description:
    
    360
    +   *   Other structures, enumerations, and macros.  Deprecated functions are
    
    361
    +   *   also listed here.
    
    362
    +   *
    
    363
    +   * @order:
    
    268 364
        *   FT_Face_Internal
    
    269 365
        *   FT_Size_Internal
    
    270 366
        *   FT_Slot_Internal
    
    271 367
        *
    
    272
    -   *   FT_FACE_FLAG_XXX
    
    273
    -   *   FT_STYLE_FLAG_XXX
    
    274
    -   *   FT_OPEN_XXX
    
    275
    -   *   FT_LOAD_XXX
    
    276
    -   *   FT_LOAD_TARGET_XXX
    
    277
    -   *   FT_SUBGLYPH_FLAG_XXX
    
    278
    -   *   FT_FSTYPE_XXX
    
    368
    +   *   FT_SubGlyph
    
    279 369
        *
    
    280 370
        *   FT_HAS_FAST_GLYPHS
    
    371
    +   *   FT_Face_CheckTrueTypePatents
    
    372
    +   *   FT_Face_SetUnpatentedHinting
    
    281 373
        *
    
    282 374
        */
    
    283 375
     
    
    284 376
     
    
    377
    +  /*************************************************************************/
    
    378
    +  /*************************************************************************/
    
    379
    +  /*                                                                       */
    
    380
    +  /*                        B A S I C   T Y P E S                          */
    
    381
    +  /*                                                                       */
    
    382
    +  /*************************************************************************/
    
    383
    +  /*************************************************************************/
    
    384
    +
    
    385
    +
    
    386
    +  /**************************************************************************
    
    387
    +   *
    
    388
    +   * @section:
    
    389
    +   *   glyph_retrieval
    
    390
    +   *
    
    391
    +   */
    
    392
    +
    
    285 393
       /**************************************************************************
    
    286 394
        *
    
    287 395
        * @struct:
    
    ... ... @@ -349,6 +457,13 @@ FT_BEGIN_HEADER
    349 457
       } FT_Glyph_Metrics;
    
    350 458
     
    
    351 459
     
    
    460
    +  /**************************************************************************
    
    461
    +   *
    
    462
    +   * @section:
    
    463
    +   *   sizing_and_scaling
    
    464
    +   *
    
    465
    +   */
    
    466
    +
    
    352 467
       /**************************************************************************
    
    353 468
        *
    
    354 469
        * @struct:
    
    ... ... @@ -409,6 +524,13 @@ FT_BEGIN_HEADER
    409 524
       /*************************************************************************/
    
    410 525
       /*************************************************************************/
    
    411 526
     
    
    527
    +  /**************************************************************************
    
    528
    +   *
    
    529
    +   * @section:
    
    530
    +   *   library_setup
    
    531
    +   *
    
    532
    +   */
    
    533
    +
    
    412 534
       /**************************************************************************
    
    413 535
        *
    
    414 536
        * @type:
    
    ... ... @@ -483,7 +605,7 @@ FT_BEGIN_HEADER
    483 605
       /**************************************************************************
    
    484 606
        *
    
    485 607
        * @section:
    
    486
    -   *   base_interface
    
    608
    +   *   face_creation
    
    487 609
        *
    
    488 610
        */
    
    489 611
     
    
    ... ... @@ -519,6 +641,13 @@ FT_BEGIN_HEADER
    519 641
       typedef struct FT_FaceRec_*  FT_Face;
    
    520 642
     
    
    521 643
     
    
    644
    +  /**************************************************************************
    
    645
    +   *
    
    646
    +   * @section:
    
    647
    +   *   sizing_and_scaling
    
    648
    +   *
    
    649
    +   */
    
    650
    +
    
    522 651
       /**************************************************************************
    
    523 652
        *
    
    524 653
        * @type:
    
    ... ... @@ -551,6 +680,13 @@ FT_BEGIN_HEADER
    551 680
       typedef struct FT_SizeRec_*  FT_Size;
    
    552 681
     
    
    553 682
     
    
    683
    +  /**************************************************************************
    
    684
    +   *
    
    685
    +   * @section:
    
    686
    +   *   glyph_retrieval
    
    687
    +   *
    
    688
    +   */
    
    689
    +
    
    554 690
       /**************************************************************************
    
    555 691
        *
    
    556 692
        * @type:
    
    ... ... @@ -570,6 +706,13 @@ FT_BEGIN_HEADER
    570 706
       typedef struct FT_GlyphSlotRec_*  FT_GlyphSlot;
    
    571 707
     
    
    572 708
     
    
    709
    +  /**************************************************************************
    
    710
    +   *
    
    711
    +   * @section:
    
    712
    +   *   character_mapping
    
    713
    +   *
    
    714
    +   */
    
    715
    +
    
    573 716
       /**************************************************************************
    
    574 717
        *
    
    575 718
        * @type:
    
    ... ... @@ -877,6 +1020,13 @@ FT_BEGIN_HEADER
    877 1020
       /*************************************************************************/
    
    878 1021
     
    
    879 1022
     
    
    1023
    +  /**************************************************************************
    
    1024
    +   *
    
    1025
    +   * @section:
    
    1026
    +   *   other_api_data
    
    1027
    +   *
    
    1028
    +   */
    
    1029
    +
    
    880 1030
       /**************************************************************************
    
    881 1031
        *
    
    882 1032
        * @type:
    
    ... ... @@ -892,6 +1042,13 @@ FT_BEGIN_HEADER
    892 1042
       typedef struct FT_Face_InternalRec_*  FT_Face_Internal;
    
    893 1043
     
    
    894 1044
     
    
    1045
    +  /**************************************************************************
    
    1046
    +   *
    
    1047
    +   * @section:
    
    1048
    +   *   face_creation
    
    1049
    +   *
    
    1050
    +   */
    
    1051
    +
    
    895 1052
       /**************************************************************************
    
    896 1053
        *
    
    897 1054
        * @struct:
    
    ... ... @@ -1272,6 +1429,13 @@ FT_BEGIN_HEADER
    1272 1429
     #define FT_FACE_FLAG_SBIX_OVERLAY      ( 1L << 18 )
    
    1273 1430
     
    
    1274 1431
     
    
    1432
    +  /**************************************************************************
    
    1433
    +   *
    
    1434
    +   * @section:
    
    1435
    +   *   font_testing_macros
    
    1436
    +   *
    
    1437
    +   */
    
    1438
    +
    
    1275 1439
       /**************************************************************************
    
    1276 1440
        *
    
    1277 1441
        * @macro:
    
    ... ... @@ -1381,6 +1545,13 @@ FT_BEGIN_HEADER
    1381 1545
               ( !!( (face)->face_flags & FT_FACE_FLAG_FIXED_SIZES ) )
    
    1382 1546
     
    
    1383 1547
     
    
    1548
    +  /**************************************************************************
    
    1549
    +   *
    
    1550
    +   * @section:
    
    1551
    +   *   other_api_data
    
    1552
    +   *
    
    1553
    +   */
    
    1554
    +
    
    1384 1555
       /**************************************************************************
    
    1385 1556
        *
    
    1386 1557
        * @macro:
    
    ... ... @@ -1393,6 +1564,13 @@ FT_BEGIN_HEADER
    1393 1564
     #define FT_HAS_FAST_GLYPHS( face )  0
    
    1394 1565
     
    
    1395 1566
     
    
    1567
    +  /**************************************************************************
    
    1568
    +   *
    
    1569
    +   * @section:
    
    1570
    +   *   font_testing_macros
    
    1571
    +   *
    
    1572
    +   */
    
    1573
    +
    
    1396 1574
       /**************************************************************************
    
    1397 1575
        *
    
    1398 1576
        * @macro:
    
    ... ... @@ -1628,6 +1806,13 @@ FT_BEGIN_HEADER
    1628 1806
               ( !!( (face)->face_flags & FT_FACE_FLAG_SBIX_OVERLAY ) )
    
    1629 1807
     
    
    1630 1808
     
    
    1809
    +  /**************************************************************************
    
    1810
    +   *
    
    1811
    +   * @section:
    
    1812
    +   *   face_creation
    
    1813
    +   *
    
    1814
    +   */
    
    1815
    +
    
    1631 1816
       /**************************************************************************
    
    1632 1817
        *
    
    1633 1818
        * @enum:
    
    ... ... @@ -1654,6 +1839,13 @@ FT_BEGIN_HEADER
    1654 1839
     #define FT_STYLE_FLAG_BOLD    ( 1 << 1 )
    
    1655 1840
     
    
    1656 1841
     
    
    1842
    +  /**************************************************************************
    
    1843
    +   *
    
    1844
    +   * @section:
    
    1845
    +   *   other_api_data
    
    1846
    +   *
    
    1847
    +   */
    
    1848
    +
    
    1657 1849
       /**************************************************************************
    
    1658 1850
        *
    
    1659 1851
        * @type:
    
    ... ... @@ -1666,6 +1858,13 @@ FT_BEGIN_HEADER
    1666 1858
       typedef struct FT_Size_InternalRec_*  FT_Size_Internal;
    
    1667 1859
     
    
    1668 1860
     
    
    1861
    +  /**************************************************************************
    
    1862
    +   *
    
    1863
    +   * @section:
    
    1864
    +   *   sizing_and_scaling
    
    1865
    +   *
    
    1866
    +   */
    
    1867
    +
    
    1669 1868
       /**************************************************************************
    
    1670 1869
        *
    
    1671 1870
        * @struct:
    
    ... ... @@ -1817,6 +2016,13 @@ FT_BEGIN_HEADER
    1817 2016
       } FT_SizeRec;
    
    1818 2017
     
    
    1819 2018
     
    
    2019
    +  /**************************************************************************
    
    2020
    +   *
    
    2021
    +   * @section:
    
    2022
    +   *   other_api_data
    
    2023
    +   *
    
    2024
    +   */
    
    2025
    +
    
    1820 2026
       /**************************************************************************
    
    1821 2027
        *
    
    1822 2028
        * @struct:
    
    ... ... @@ -1848,6 +2054,13 @@ FT_BEGIN_HEADER
    1848 2054
       typedef struct FT_Slot_InternalRec_*  FT_Slot_Internal;
    
    1849 2055
     
    
    1850 2056
     
    
    2057
    +  /**************************************************************************
    
    2058
    +   *
    
    2059
    +   * @section:
    
    2060
    +   *   glyph_retrieval
    
    2061
    +   *
    
    2062
    +   */
    
    2063
    +
    
    1851 2064
       /**************************************************************************
    
    1852 2065
        *
    
    1853 2066
        * @struct:
    
    ... ... @@ -2092,6 +2305,13 @@ FT_BEGIN_HEADER
    2092 2305
       /*************************************************************************/
    
    2093 2306
     
    
    2094 2307
     
    
    2308
    +  /**************************************************************************
    
    2309
    +   *
    
    2310
    +   * @section:
    
    2311
    +   *   library_setup
    
    2312
    +   *
    
    2313
    +   */
    
    2314
    +
    
    2095 2315
       /**************************************************************************
    
    2096 2316
        *
    
    2097 2317
        * @function:
    
    ... ... @@ -2149,6 +2369,13 @@ FT_BEGIN_HEADER
    2149 2369
       FT_Done_FreeType( FT_Library  library );
    
    2150 2370
     
    
    2151 2371
     
    
    2372
    +  /**************************************************************************
    
    2373
    +   *
    
    2374
    +   * @section:
    
    2375
    +   *   face_creation
    
    2376
    +   *
    
    2377
    +   */
    
    2378
    +
    
    2152 2379
       /**************************************************************************
    
    2153 2380
        *
    
    2154 2381
        * @enum:
    
    ... ... @@ -2650,6 +2877,13 @@ FT_BEGIN_HEADER
    2650 2877
       FT_Done_Face( FT_Face  face );
    
    2651 2878
     
    
    2652 2879
     
    
    2880
    +  /**************************************************************************
    
    2881
    +   *
    
    2882
    +   * @section:
    
    2883
    +   *   sizing_and_scaling
    
    2884
    +   *
    
    2885
    +   */
    
    2886
    +
    
    2653 2887
       /**************************************************************************
    
    2654 2888
        *
    
    2655 2889
        * @function:
    
    ... ... @@ -2942,6 +3176,13 @@ FT_BEGIN_HEADER
    2942 3176
                           FT_UInt  pixel_height );
    
    2943 3177
     
    
    2944 3178
     
    
    3179
    +  /**************************************************************************
    
    3180
    +   *
    
    3181
    +   * @section:
    
    3182
    +   *   glyph_retrieval
    
    3183
    +   *
    
    3184
    +   */
    
    3185
    +
    
    2945 3186
       /**************************************************************************
    
    2946 3187
        *
    
    2947 3188
        * @function:
    
    ... ... @@ -2990,6 +3231,13 @@ FT_BEGIN_HEADER
    2990 3231
                      FT_Int32  load_flags );
    
    2991 3232
     
    
    2992 3233
     
    
    3234
    +  /**************************************************************************
    
    3235
    +   *
    
    3236
    +   * @section:
    
    3237
    +   *   character_mapping
    
    3238
    +   *
    
    3239
    +   */
    
    3240
    +
    
    2993 3241
       /**************************************************************************
    
    2994 3242
        *
    
    2995 3243
        * @function:
    
    ... ... @@ -3033,6 +3281,13 @@ FT_BEGIN_HEADER
    3033 3281
                     FT_Int32  load_flags );
    
    3034 3282
     
    
    3035 3283
     
    
    3284
    +  /**************************************************************************
    
    3285
    +   *
    
    3286
    +   * @section:
    
    3287
    +   *   glyph_retrieval
    
    3288
    +   *
    
    3289
    +   */
    
    3290
    +
    
    3036 3291
       /**************************************************************************
    
    3037 3292
        *
    
    3038 3293
        * @enum:
    
    ... ... @@ -3372,6 +3627,13 @@ FT_BEGIN_HEADER
    3372 3627
               FT_STATIC_CAST( FT_Render_Mode, ( (x) >> 16 ) & 15 )
    
    3373 3628
     
    
    3374 3629
     
    
    3630
    +  /**************************************************************************
    
    3631
    +   *
    
    3632
    +   * @section:
    
    3633
    +   *   sizing_and_scaling
    
    3634
    +   *
    
    3635
    +   */
    
    3636
    +
    
    3375 3637
       /**************************************************************************
    
    3376 3638
        *
    
    3377 3639
        * @function:
    
    ... ... @@ -3447,6 +3709,13 @@ FT_BEGIN_HEADER
    3447 3709
                         FT_Vector*  delta );
    
    3448 3710
     
    
    3449 3711
     
    
    3712
    +  /**************************************************************************
    
    3713
    +   *
    
    3714
    +   * @section:
    
    3715
    +   *   glyph_retrieval
    
    3716
    +   *
    
    3717
    +   */
    
    3718
    +
    
    3450 3719
       /**************************************************************************
    
    3451 3720
        *
    
    3452 3721
        * @enum:
    
    ... ... @@ -3841,6 +4110,13 @@ FT_BEGIN_HEADER
    3841 4110
                             FT_Fixed*  akerning );
    
    3842 4111
     
    
    3843 4112
     
    
    4113
    +  /**************************************************************************
    
    4114
    +   *
    
    4115
    +   * @section:
    
    4116
    +   *   character_mapping
    
    4117
    +   *
    
    4118
    +   */
    
    4119
    +
    
    3844 4120
       /**************************************************************************
    
    3845 4121
        *
    
    3846 4122
        * @function:
    
    ... ... @@ -4057,6 +4333,13 @@ FT_BEGIN_HEADER
    4057 4333
                         FT_UInt   *agindex );
    
    4058 4334
     
    
    4059 4335
     
    
    4336
    +  /**************************************************************************
    
    4337
    +   *
    
    4338
    +   * @section:
    
    4339
    +   *   face_creation
    
    4340
    +   *
    
    4341
    +   */
    
    4342
    +
    
    4060 4343
       /**************************************************************************
    
    4061 4344
        *
    
    4062 4345
        * @function:
    
    ... ... @@ -4155,6 +4438,13 @@ FT_BEGIN_HEADER
    4155 4438
                           FT_Parameter*  properties );
    
    4156 4439
     
    
    4157 4440
     
    
    4441
    +  /**************************************************************************
    
    4442
    +   *
    
    4443
    +   * @section:
    
    4444
    +   *   information_retrieval
    
    4445
    +   *
    
    4446
    +   */
    
    4447
    +
    
    4158 4448
       /**************************************************************************
    
    4159 4449
        *
    
    4160 4450
        * @function:
    
    ... ... @@ -4900,32 +5190,10 @@ FT_BEGIN_HEADER
    4900 5190
       /**************************************************************************
    
    4901 5191
        *
    
    4902 5192
        * @section:
    
    4903
    -   *   version
    
    4904
    -   *
    
    4905
    -   * @title:
    
    4906
    -   *   FreeType Version
    
    4907
    -   *
    
    4908
    -   * @abstract:
    
    4909
    -   *   Functions and macros related to FreeType versions.
    
    4910
    -   *
    
    4911
    -   * @description:
    
    4912
    -   *   Note that those functions and macros are of limited use because even a
    
    4913
    -   *   new release of FreeType with only documentation changes increases the
    
    4914
    -   *   version number.
    
    4915
    -   *
    
    4916
    -   * @order:
    
    4917
    -   *   FT_Library_Version
    
    4918
    -   *
    
    4919
    -   *   FREETYPE_MAJOR
    
    4920
    -   *   FREETYPE_MINOR
    
    4921
    -   *   FREETYPE_PATCH
    
    4922
    -   *
    
    4923
    -   *   FT_Face_CheckTrueTypePatents
    
    4924
    -   *   FT_Face_SetUnpatentedHinting
    
    5193
    +   *   library_setup
    
    4925 5194
        *
    
    4926 5195
        */
    
    4927 5196
     
    
    4928
    -
    
    4929 5197
       /**************************************************************************
    
    4930 5198
        *
    
    4931 5199
        * @enum:
    
    ... ... @@ -4992,6 +5260,13 @@ FT_BEGIN_HEADER
    4992 5260
                           FT_Int      *apatch );
    
    4993 5261
     
    
    4994 5262
     
    
    5263
    +  /**************************************************************************
    
    5264
    +   *
    
    5265
    +   * @section:
    
    5266
    +   *   other_api_data
    
    5267
    +   *
    
    5268
    +   */
    
    5269
    +
    
    4995 5270
       /**************************************************************************
    
    4996 5271
        *
    
    4997 5272
        * @function:
    

  • include/freetype/ftchapters.h
    ... ... @@ -31,9 +31,28 @@
    31 31
        *   Core API
    
    32 32
        *
    
    33 33
        * @sections:
    
    34
    -   *   version
    
    35 34
        *   basic_types
    
    36
    -   *   base_interface
    
    35
    +   *   library_setup
    
    36
    +   *   face_creation
    
    37
    +   *   font_testing_macros
    
    38
    +   *   sizing_and_scaling
    
    39
    +   *   glyph_retrieval
    
    40
    +   *   character_mapping
    
    41
    +   *   information_retrieval
    
    42
    +   *   other_api_data
    
    43
    +   *
    
    44
    +   */
    
    45
    +
    
    46
    +
    
    47
    +  /**************************************************************************
    
    48
    +   *
    
    49
    +   * @chapter:
    
    50
    +   *   extended_api
    
    51
    +   *
    
    52
    +   * @title:
    
    53
    +   *   Extended API
    
    54
    +   *
    
    55
    +   * @sections:
    
    37 56
        *   glyph_variants
    
    38 57
        *   color_management
    
    39 58
        *   layer_management
    


  • reply via email to

    [Prev in Thread] Current Thread [Next in Thread]