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

Merge pull request #205 from khaledhosny/more-docs

Browse Source 
More docs
This commit is contained in:
Behdad Esfahbod 2015-12-30 22:20:14 +01:00
commit bfdf684f79
3 changed files with 115 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

74
docs/harfbuzz-docs.xml
View File

@ -77,6 +77,8 @@
<xi:include href="xml/hb-ot.xml"/>
<xi:include href="xml/hb-ot-layout.xml"/>
<xi:include href="xml/hb-ot-tag.xml"/>
<xi:include href="xml/hb-ot-font.xml"/>
<xi:include href="xml/hb-ot-shape.xml"/>
<xi:include href="xml/hb-shape-plan.xml"/>
@ -100,6 +102,78 @@
<title>API Index</title>
<xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
</index>
<index id="api-index-0-9-2" role="0.9.2">
<title>Index of new symbols in 0.9.2</title>
<xi:include href="xml/api-index-0.9.2.xml"><xi:fallback /></xi:include>
</index>
<index id="api-index-0-9-5" role="0.9.5">
<title>Index of new symbols in 0.9.5</title>
<xi:include href="xml/api-index-0.9.5.xml"><xi:fallback /></xi:include>
</index>
<index id="api-index-0-9-7" role="0.9.7">
<title>Index of new symbols in 0.9.7</title>
<xi:include href="xml/api-index-0.9.7.xml"><xi:fallback /></xi:include>
</index>
<index id="api-index-0-9-8" role="0.9.8">
<title>Index of new symbols in 0.9.8</title>
<xi:include href="xml/api-index-0.9.8.xml"><xi:fallback /></xi:include>
</index>
<index id="api-index-0-9-10" role="0.9.10">
<title>Index of new symbols in 0.9.10</title>
<xi:include href="xml/api-index-0.9.10.xml"><xi:fallback /></xi:include>
</index>
<index id="api-index-0-9-11" role="0.9.11">
<title>Index of new symbols in 0.9.11</title>
<xi:include href="xml/api-index-0.9.11.xml"><xi:fallback /></xi:include>
</index>
<index id="api-index-0-9-20" role="0.9.20">
<title>Index of new symbols in 0.9.20</title>
<xi:include href="xml/api-index-0.9.20.xml"><xi:fallback /></xi:include>
</index>
<index id="api-index-0-9-22" role="0.9.22">
<title>Index of new symbols in 0.9.22</title>
<xi:include href="xml/api-index-0.9.22.xml"><xi:fallback /></xi:include>
</index>
<index id="api-index-0-9-28" role="0.9.28">
<title>Index of new symbols in 0.9.28</title>
<xi:include href="xml/api-index-0.9.28.xml"><xi:fallback /></xi:include>
</index>
<index id="api-index-0-9-30" role="0.9.30">
<title>Index of new symbols in 0.9.30</title>
<xi:include href="xml/api-index-0.9.30.xml"><xi:fallback /></xi:include>
</index>
<index id="api-index-0-9-31" role="0.9.31">
<title>Index of new symbols in 0.9.31</title>
<xi:include href="xml/api-index-0.9.31.xml"><xi:fallback /></xi:include>
</index>
<index id="api-index-0-9-38" role="0.9.38">
<title>Index of new symbols in 0.9.38</title>
<xi:include href="xml/api-index-0.9.38.xml"><xi:fallback /></xi:include>
</index>
<index id="api-index-0-9-39" role="0.9.39">
<title>Index of new symbols in 0.9.39</title>
<xi:include href="xml/api-index-0.9.39.xml"><xi:fallback /></xi:include>
</index>
<index id="api-index-0-9-41" role="0.9.41">
<title>Index of new symbols in 0.9.41</title>
<xi:include href="xml/api-index-0.9.41.xml"><xi:fallback /></xi:include>
</index>
<index id="api-index-0-9-42" role="0.9.42">
<title>Index of new symbols in 0.9.42</title>
<xi:include href="xml/api-index-0.9.42.xml"><xi:fallback /></xi:include>
</index>
<index id="api-index-1-0-5" role="1.0.5">
<title>Index of new symbols in 1.0.5</title>
<xi:include href="xml/api-index-1.0.5.xml"><xi:fallback /></xi:include>
</index>
<index id="api-index-1-1-2" role="1.1.2">
<title>Index of new symbols in 1.1.2</title>
<xi:include href="xml/api-index-1.1.2.xml"><xi:fallback /></xi:include>
</index>
<index id="api-index-1-1-3" role="1.1.3">
<title>Index of new symbols in 1.1.3</title>
<xi:include href="xml/api-index-1.1.3.xml"><xi:fallback /></xi:include>
</index>
<index id="deprecated-api-index" role="deprecated">
<title>Index of deprecated API</title>
<xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include>

40
docs/harfbuzz-sections.txt
View File

@ -2,6 +2,7 @@
<FILE>hb</FILE>
<SUBSECTION Private>
HB_H_IN
HB_EXTERN
</SECTION>
<SECTION>
@ -25,6 +26,7 @@ hb_memory_mode_t
<SECTION>
<FILE>hb-buffer</FILE>
HB_SEGMENT_PROPERTIES_DEFAULT
HB_BUFFER_REPLACEMENT_CODEPOINT_DEFAULT
hb_buffer_create
hb_buffer_reference
hb_buffer_get_empty
@ -38,6 +40,7 @@ hb_buffer_add_codepoints
hb_buffer_add_utf32
hb_buffer_add_utf16
hb_buffer_add_utf8
hb_buffer_add_latin1
hb_buffer_set_content_type
hb_buffer_get_content_type
hb_buffer_set_direction
@ -61,8 +64,11 @@ hb_buffer_set_user_data
hb_buffer_get_user_data
hb_buffer_get_glyph_infos
hb_buffer_get_glyph_positions
hb_buffer_set_replacement_codepoint
hb_buffer_get_replacement_codepoint
hb_buffer_normalize_glyphs
hb_buffer_reverse
hb_buffer_reverse_range
hb_buffer_reverse_clusters
hb_buffer_serialize_glyphs
hb_buffer_deserialize_glyphs
@ -71,14 +77,17 @@ hb_buffer_serialize_format_to_string
hb_buffer_serialize_list_formats
hb_segment_properties_equal
hb_segment_properties_hash
hb_buffer_set_message_func
hb_buffer_t
hb_glyph_info_t
hb_glyph_position_t
hb_buffer_content_type_t
hb_buffer_flags_t
hb_buffer_cluster_level_t
hb_buffer_serialize_flags_t
hb_segment_properties_t
hb_buffer_serialize_format_t
hb_buffer_message_func_t
</SECTION>
<SECTION>
@ -108,6 +117,7 @@ hb_var_int_t
HB_TAG
HB_TAG_NONE
HB_TAG_MAX
HB_TAG_MAX_SIGNED
HB_UNTAG
HB_DIRECTION_REVERSE
HB_DIRECTION_IS_BACKWARD
@ -242,14 +252,27 @@ hb_font_set_user_data
hb_font_subtract_glyph_origin_for_direction
hb_font_t
hb_reference_table_func_t
hb_font_funcs_set_font_h_extents_func
hb_font_funcs_set_font_v_extents_func
hb_font_get_extents_for_direction
hb_font_get_font_extents_func_t
hb_font_get_font_h_extents_func_t
hb_font_get_font_v_extents_func_t
hb_font_get_h_extents
hb_font_get_v_extents
hb_font_set_parent
</SECTION>
<SECTION>
<FILE>hb-ft</FILE>
hb_ft_face_create
hb_ft_face_create_cached
hb_ft_face_create_referenced
hb_ft_font_create
hb_ft_font_create_referenced
hb_ft_font_get_face
hb_ft_font_set_load_flags
hb_ft_font_get_load_flags
hb_ft_font_set_funcs
</SECTION>
@ -258,6 +281,7 @@ hb_ft_font_set_funcs
hb_glib_get_unicode_funcs
hb_glib_script_from_script
hb_glib_script_to_script
hb_glib_blob_create
</SECTION>
<SECTION>
@ -279,6 +303,13 @@ HB_GOBJECT_TYPE_SHAPE_PLAN
HB_GOBJECT_TYPE_UNICODE_COMBINING_CLASS
HB_GOBJECT_TYPE_UNICODE_FUNCS
HB_GOBJECT_TYPE_UNICODE_GENERAL_CATEGORY
HB_GOBJECT_TYPE_BUFFER_CLUSTER_LEVEL
HB_GOBJECT_TYPE_FEATURE
HB_GOBJECT_TYPE_GLYPH_INFO
HB_GOBJECT_TYPE_GLYPH_POSITION
HB_GOBJECT_TYPE_SEGMENT_PROPERTIES
HB_GOBJECT_TYPE_SET
HB_GOBJECT_TYPE_USER_DATA_KEY
hb_gobject_blob_get_type
hb_gobject_buffer_content_type_get_type
hb_gobject_buffer_flags_get_type
@ -296,6 +327,13 @@ hb_gobject_shape_plan_get_type
hb_gobject_unicode_combining_class_get_type
hb_gobject_unicode_funcs_get_type
hb_gobject_unicode_general_category_get_type
hb_gobject_buffer_cluster_level_get_type
hb_gobject_feature_get_type
hb_gobject_glyph_info_get_type
hb_gobject_glyph_position_get_type
hb_gobject_segment_properties_get_type
hb_gobject_set_get_type
hb_gobject_user_data_key_get_type
<SUBSECTION Private>
HB_GOBJECT_H_IN
</SECTION>
@ -343,6 +381,7 @@ HB_OT_LAYOUT_NO_SCRIPT_INDEX
HB_OT_TAG_GDEF
HB_OT_TAG_GPOS
HB_OT_TAG_GSUB
HB_OT_TAG_JSTF
hb_ot_layout_collect_lookups
hb_ot_layout_feature_get_lookups
hb_ot_layout_get_attach_points
@ -370,6 +409,7 @@ hb_ot_layout_table_get_feature_tags
hb_ot_layout_table_get_script_tags
hb_ot_layout_table_get_lookup_count
hb_ot_shape_plan_collect_lookups
hb_ot_layout_language_get_required_feature_index
<SUBSECTION Private>
Xhb_ot_layout_lookup_enumerate_sequences
Xhb_ot_layout_lookup_position

2
src/hb-buffer.cc
View File

@ -723,7 +723,7 @@ void hb_buffer_t::deallocate_var_all (void)
*
* Return value: (transfer full):
* A newly allocated #hb_buffer_t with a reference count of 1. The initial
* reference count should be released with hb_buffe_destroy() when you are done
* reference count should be released with hb_buffer_destroy() when you are done
* using the #hb_buffer_t. This function never returns %NULL. If memory cannot
* be allocated, a special #hb_buffer_t object will be returned on which
* hb_buffer_allocation_successful() returns %false.