GNOME.org
 

[pangomm] Improve the generated API documentation.

commit c26b848fb0536d8eea834fa221fb00d6e2f6cc2b
Author: Murray Cumming <murrayc murrayc com>
Date:   Sat Jan 8 14:52:15 2011 +0100

    Improve the generated API documentation.
    
    * pango/src/pango_methods.defs: Regenerated with h2defs.py
    * pango/src/pango_extra_objects.defs: Added some object definitions to help
    the documentation generator, avoiding warnings about not being able to
    transform C function names into C++ function names. I did the same thing in
    gtkmm a few months ago.
    * pango/src/filelist.am: Mention the new files.
    * pango/src/pango.defs: Include the new file.

 ChangeLog                    |   12 +
 pango/src/filelist.am        |    1 +
 pango/src/pango.defs         |    1 +
 pango/src/pango_methods.defs |  508 ------------------------------------------
 4 files changed, 14 insertions(+), 508 deletions(-)
---
diff --git a/ChangeLog b/ChangeLog
index ecb3155..cc80c74 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,17 @@
 2011-01-08  Murray Cumming  <murrayc murrayc com>
 
+	Improve the generated API documentation.
+
+	* pango/src/pango_methods.defs: Regenerated with h2defs.py
+	* pango/src/pango_extra_objects.defs: Added some object definitions to help
+	the documentation generator, avoiding warnings about not being able to 
+	transform C function names into C++ function names. I did the same thing in 
+	gtkmm a few months ago.
+	* pango/src/filelist.am: Mention the new files.
+	* pango/src/pango.defs: Include the new file.
+
+2011-01-08  Murray Cumming  <murrayc murrayc com>
+
 	Added conversions used by gtkmm.
 
 	* tools/m4/convert_pango.m4: Added the extra conversions that were in the 
diff --git a/pango/src/filelist.am b/pango/src/filelist.am
index 061c344..2a2557e 100644
--- a/pango/src/filelist.am
+++ b/pango/src/filelist.am
@@ -5,6 +5,7 @@ files_defs =			\
 	pango_methods.defs	\
 	pango_enums.defs	\
 	pango_vfuncs.defs	\
+	pango_extra_objects.defs \
 	pango_docs.xml		\
 	pango_docs_override.xml
 
diff --git a/pango/src/pango.defs b/pango/src/pango.defs
index 886fba3..8c174b7 100644
--- a/pango/src/pango.defs
+++ b/pango/src/pango.defs
@@ -1,5 +1,6 @@
 (include pango_methods.defs)
 (include pango_vfuncs.defs)
 (include pango_enums.defs)
+(include pango_extra_objects.defs)
 
 
diff --git a/pango/src/pango_methods.defs b/pango/src/pango_methods.defs
index 0d5cb0c..0494fc2 100644
--- a/pango/src/pango_methods.defs
+++ b/pango/src/pango_methods.defs
@@ -1,17 +1,5 @@
 ;; -*- scheme -*-
 ; object definitions ...
-(define-object CairoFont
-  (in-module "Pango")
-  (c-name "PangoCairoFont")
-  (gtype-id "PANGO_TYPE_CAIRO_FONT")
-)
-
-(define-object CairoFontMap
-  (in-module "Pango")
-  (c-name "PangoCairoFontMap")
-  (gtype-id "PANGO_TYPE_CAIRO_FONT_MAP")
-)
-
 (define-object Engine
   (in-module "Pango")
   (parent "GObject")
@@ -54,13 +42,6 @@
   (gtype-id "PANGO_TYPE_FC_FONT")
 )
 
-(define-object ATSUIFont
-  (in-module "Pango")
-  (parent "PangoFont")
-  (c-name "PangoATSUIFont")
-  (gtype-id "PANGO_TYPE_ATSUI_FONT")
-)
-
 (define-object FontFace
   (in-module "Pango")
   (parent "GObject")
@@ -89,13 +70,6 @@
   (gtype-id "PANGO_TYPE_FC_FONT_MAP")
 )
 
-(define-object ATSUIFontMap
-  (in-module "Pango")
-  (parent "PangoFontMap")
-  (c-name "PangoATSUIFontMap")
-  (gtype-id "PANGO_TYPE_ATSUI_FONT_MAP")
-)
-
 (define-object Fontset
   (in-module "Pango")
   (parent "GObject")
@@ -103,20 +77,6 @@
   (gtype-id "PANGO_TYPE_FONTSET")
 )
 
-(define-object OTInfo
-  (in-module "Pango")
-  (parent "GObject")
-  (c-name "PangoOTInfo")
-  (gtype-id "PANGO_TYPE_OT_INFO")
-)
-
-(define-object OTRuleset
-  (in-module "Pango")
-  (parent "GObject")
-  (c-name "PangoOTRuleset")
-  (gtype-id "PANGO_TYPE_OT_RULESET")
-)
-
 (define-object Renderer
   (in-module "Pango")
   (parent "GObject")
@@ -124,20 +84,6 @@
   (gtype-id "PANGO_TYPE_RENDERER")
 )
 
-(define-object Win32Font
-  (in-module "Pango")
-  (parent "PangoFont")
-  (c-name "PangoWin32Font")
-  (gtype-id "PANGO_TYPE_WIN32_FONT")
-)
-
-(define-object Win32FontMap
-  (in-module "Pango")
-  (parent "PangoFontMap")
-  (c-name "PangoWin32FontMap")
-  (gtype-id "PANGO_TYPE_WIN32_FONT_MAP")
-)
-
 (define-object XftRenderer
   (in-module "Pango")
   (parent "PangoRenderer")
@@ -494,36 +440,6 @@
 )
 
 
-;; From pangoatsui.h
-
-(define-method get_cgfont
-  (of-object "PangoATSUIFont")
-  (c-name "pango_atsui_font_get_cgfont")
-  (return-type "CGFontRef")
-)
-
-(define-method get_atsfont
-  (of-object "PangoATSUIFont")
-  (c-name "pango_atsui_font_get_atsfont")
-  (return-type "ATSFontRef")
-)
-
-(define-function pango_atsui_font_get_type
-  (c-name "pango_atsui_font_get_type")
-  (return-type "GType")
-)
-
-
-
-;; From pangoatsui-private.h
-
-(define-function pango_atsui_font_map_get_type
-  (c-name "pango_atsui_font_map_get_type")
-  (return-type "GType")
-)
-
-
-
 ;; From pango-attributes.h
 
 (define-function pango_color_get_type
@@ -1063,33 +979,6 @@
 
 
 
-;; From pangocairo-atsuifont.h
-
-(define-function pango_cairo_atsui_font_get_type
-  (c-name "pango_cairo_atsui_font_get_type")
-  (return-type "GType")
-)
-
-
-
-;; From pangocairo-atsui.h
-
-(define-function pango_cairo_atsui_font_map_get_type
-  (c-name "pango_cairo_atsui_font_map_get_type")
-  (return-type "GType")
-)
-
-
-
-;; From pangocairo-fc.h
-
-(define-function pango_cairo_fc_font_map_get_type
-  (c-name "pango_cairo_fc_font_map_get_type")
-  (return-type "GType")
-)
-
-
-
 ;; From pangocairo.h
 
 (define-function pango_cairo_font_map_get_type
@@ -1340,28 +1229,6 @@
 
 
 
-;; From pangocairo-private.h
-
-(define-function pango_cairo_renderer_get_type
-  (c-name "pango_cairo_renderer_get_type")
-  (return-type "GType")
-)
-
-
-
-;; From pangocairo-win32.h
-
-(define-function pango_cairo_win32_font_map_get_type
-  (c-name "pango_cairo_win32_font_map_get_type")
-  (return-type "GType")
-)
-
-
-
-;; From pango-color-table.h
-
-
-
 ;; From pango-context.h
 
 (define-function pango_context_get_type
@@ -1678,10 +1545,6 @@
 
 
 
-;; From pango-engine-private.h
-
-
-
 ;; From pango-enum-types.h
 
 (define-function pango_attr_type_get_type
@@ -1971,31 +1834,6 @@
 
 
 
-;; From pangofc-private.h
-
-(define-method get_raw_extents
-  (of-object "PangoFcFont")
-  (c-name "pango_fc_font_get_raw_extents")
-  (return-type "none")
-  (parameters
-    '("FT_Int32" "load_flags")
-    '("PangoGlyph" "glyph")
-    '("PangoRectangle*" "ink_rect")
-    '("PangoRectangle*" "logical_rect")
-  )
-)
-
-(define-method create_metrics_for_context
-  (of-object "PangoFcFont")
-  (c-name "pango_fc_font_create_metrics_for_context")
-  (return-type "PangoFontMetrics*")
-  (parameters
-    '("PangoContext*" "context")
-  )
-)
-
-
-
 ;; From pango-features.h
 
 
@@ -2730,20 +2568,6 @@
 
 
 
-;; From pangoft2-private.h
-
-(define-function pango_ft2_font_get_type
-  (c-name "pango_ft2_font_get_type")
-  (return-type "GType")
-)
-
-(define-function pango_ft2_renderer_get_type
-  (c-name "pango_ft2_renderer_get_type")
-  (return-type "GType")
-)
-
-
-
 ;; From pango-glyph.h
 
 (define-function pango_glyph_string_new
@@ -3023,10 +2847,6 @@
 
 
 
-;; From pango-impl-utils.h
-
-
-
 ;; From pango-item.h
 
 (define-function pango_item_get_type
@@ -3125,10 +2945,6 @@
 
 
 
-;; From pango-language-sample-table.h
-
-
-
 ;; From pango-layout.h
 
 (define-function pango_layout_get_type
@@ -3792,10 +3608,6 @@
 
 
 
-;; From pango-layout-private.h
-
-
-
 ;; From pango-matrix.h
 
 (define-function pango_matrix_get_type
@@ -4254,10 +4066,6 @@
 
 
 
-;; From pango-ot-private.h
-
-
-
 ;; From pango-renderer.h
 
 (define-function pango_renderer_get_type
@@ -4483,14 +4291,6 @@
 
 
 
-;; From pango-script-lang-table.h
-
-
-
-;; From pango-script-private.h
-
-
-
 ;; From pango-tabs.h
 
 (define-function pango_tab_array_new
@@ -4807,208 +4607,6 @@
 
 
 
-;; From pangowin32.h
-
-(define-function pango_win32_get_context
-  (c-name "pango_win32_get_context")
-  (return-type "PangoContext*")
-)
-
-(define-function pango_win32_render
-  (c-name "pango_win32_render")
-  (return-type "none")
-  (parameters
-    '("HDC" "hdc")
-    '("PangoFont*" "font")
-    '("PangoGlyphString*" "glyphs")
-    '("gint" "x")
-    '("gint" "y")
-  )
-)
-
-(define-function pango_win32_render_layout_line
-  (c-name "pango_win32_render_layout_line")
-  (return-type "none")
-  (parameters
-    '("HDC" "hdc")
-    '("PangoLayoutLine*" "line")
-    '("int" "x")
-    '("int" "y")
-  )
-)
-
-(define-function pango_win32_render_layout
-  (c-name "pango_win32_render_layout")
-  (return-type "none")
-  (parameters
-    '("HDC" "hdc")
-    '("PangoLayout*" "layout")
-    '("int" "x")
-    '("int" "y")
-  )
-)
-
-(define-function pango_win32_render_transformed
-  (c-name "pango_win32_render_transformed")
-  (return-type "none")
-  (parameters
-    '("HDC" "hdc")
-    '("const-PangoMatrix*" "matrix")
-    '("PangoFont*" "font")
-    '("PangoGlyphString*" "glyphs")
-    '("int" "x")
-    '("int" "y")
-  )
-)
-
-(define-function pango_win32_get_unknown_glyph
-  (c-name "pango_win32_get_unknown_glyph")
-  (return-type "PangoGlyph")
-  (parameters
-    '("PangoFont*" "font")
-    '("gunichar" "wc")
-  )
-)
-
-(define-function pango_win32_font_get_glyph_index
-  (c-name "pango_win32_font_get_glyph_index")
-  (return-type "gint")
-  (parameters
-    '("PangoFont*" "font")
-    '("gunichar" "wc")
-  )
-)
-
-(define-function pango_win32_get_dc
-  (c-name "pango_win32_get_dc")
-  (return-type "HDC")
-)
-
-(define-function pango_win32_get_debug_flag
-  (c-name "pango_win32_get_debug_flag")
-  (return-type "gboolean")
-)
-
-(define-function pango_win32_font_select_font
-  (c-name "pango_win32_font_select_font")
-  (return-type "gboolean")
-  (parameters
-    '("PangoFont*" "font")
-    '("HDC" "hdc")
-  )
-)
-
-(define-function pango_win32_font_done_font
-  (c-name "pango_win32_font_done_font")
-  (return-type "none")
-  (parameters
-    '("PangoFont*" "font")
-  )
-)
-
-(define-function pango_win32_font_get_metrics_factor
-  (c-name "pango_win32_font_get_metrics_factor")
-  (return-type "double")
-  (parameters
-    '("PangoFont*" "font")
-  )
-)
-
-(define-function pango_win32_font_cache_new
-  (c-name "pango_win32_font_cache_new")
-  (is-constructor-of "PangoWin32FontCache")
-  (return-type "PangoWin32FontCache*")
-)
-
-(define-method free
-  (of-object "PangoWin32FontCache")
-  (c-name "pango_win32_font_cache_free")
-  (return-type "none")
-)
-
-(define-method load
-  (of-object "PangoWin32FontCache")
-  (c-name "pango_win32_font_cache_load")
-  (return-type "HFONT")
-  (parameters
-    '("const-LOGFONTA*" "logfont")
-  )
-)
-
-(define-method loadw
-  (of-object "PangoWin32FontCache")
-  (c-name "pango_win32_font_cache_loadw")
-  (return-type "HFONT")
-  (parameters
-    '("const-LOGFONTW*" "logfont")
-  )
-)
-
-(define-method unload
-  (of-object "PangoWin32FontCache")
-  (c-name "pango_win32_font_cache_unload")
-  (return-type "none")
-  (parameters
-    '("HFONT" "hfont")
-  )
-)
-
-(define-function pango_win32_font_map_for_display
-  (c-name "pango_win32_font_map_for_display")
-  (return-type "PangoFontMap*")
-)
-
-(define-function pango_win32_shutdown_display
-  (c-name "pango_win32_shutdown_display")
-  (return-type "none")
-)
-
-(define-function pango_win32_font_map_get_font_cache
-  (c-name "pango_win32_font_map_get_font_cache")
-  (return-type "PangoWin32FontCache*")
-  (parameters
-    '("PangoFontMap*" "font_map")
-  )
-)
-
-(define-function pango_win32_font_logfont
-  (c-name "pango_win32_font_logfont")
-  (return-type "LOGFONTA*")
-  (parameters
-    '("PangoFont*" "font")
-  )
-)
-
-(define-function pango_win32_font_logfontw
-  (c-name "pango_win32_font_logfontw")
-  (return-type "LOGFONTW*")
-  (parameters
-    '("PangoFont*" "font")
-  )
-)
-
-(define-function pango_win32_font_description_from_logfont
-  (c-name "pango_win32_font_description_from_logfont")
-  (return-type "PangoFontDescription*")
-  (parameters
-    '("const-LOGFONTA*" "lfp")
-  )
-)
-
-(define-function pango_win32_font_description_from_logfontw
-  (c-name "pango_win32_font_description_from_logfontw")
-  (return-type "PangoFontDescription*")
-  (parameters
-    '("const-LOGFONTW*" "lfp")
-  )
-)
-
-
-
-;; From pangowin32-private.h
-
-
-
 ;; From pangoxft.h
 
 (define-function pango_xft_get_font_map
@@ -5130,10 +4728,6 @@
 
 
 
-;; From pangoxft-private.h
-
-
-
 ;; From pangoxft-render.h
 
 (define-function pango_xft_renderer_get_type
@@ -5444,105 +5038,3 @@
 )
 
 
-
-;; From pangox-private.h
-
-(define-function pango_x_font_map_get_type
-  (c-name "pango_x_font_map_get_type")
-  (return-type "GType")
-)
-
-(define-function pango_x_font_new
-  (c-name "pango_x_font_new")
-  (is-constructor-of "PangoXFont")
-  (return-type "PangoXFont*")
-  (parameters
-    '("PangoFontMap*" "fontmap")
-    '("const-char*" "spec")
-    '("int" "size")
-  )
-)
-
-(define-function pango_x_get_shaper_map
-  (c-name "pango_x_get_shaper_map")
-  (return-type "PangoMap*")
-  (parameters
-    '("PangoLanguage*" "language")
-  )
-)
-
-(define-function pango_x_make_matching_xlfd
-  (c-name "pango_x_make_matching_xlfd")
-  (return-type "char*")
-  (parameters
-    '("PangoFontMap*" "fontmap")
-    '("char*" "xlfd")
-    '("const-char*" "charset")
-    '("int" "size")
-  )
-)
-
-(define-method get_coverage
-  (of-object "PangoXFace")
-  (c-name "pango_x_face_get_coverage")
-  (return-type "PangoCoverage*")
-  (parameters
-    '("PangoFont*" "font")
-    '("PangoLanguage*" "language")
-  )
-)
-
-(define-method remove
-  (of-object "PangoXFace")
-  (c-name "pango_x_face_remove")
-  (return-type "none")
-  (parameters
-    '("PangoFont*" "font")
-  )
-)
-
-(define-function pango_x_fontmap_get_display
-  (c-name "pango_x_fontmap_get_display")
-  (return-type "Display*")
-  (parameters
-    '("PangoFontMap*" "fontmap")
-  )
-)
-
-(define-function pango_x_fontmap_cache_add
-  (c-name "pango_x_fontmap_cache_add")
-  (return-type "none")
-  (parameters
-    '("PangoFontMap*" "fontmap")
-    '("PangoXFont*" "xfont")
-  )
-)
-
-(define-function pango_x_fontmap_cache_remove
-  (c-name "pango_x_fontmap_cache_remove")
-  (return-type "none")
-  (parameters
-    '("PangoFontMap*" "fontmap")
-    '("PangoXFont*" "xfont")
-  )
-)
-
-(define-function pango_x_fontmap_atom_from_name
-  (c-name "pango_x_fontmap_atom_from_name")
-  (return-type "Atom")
-  (parameters
-    '("PangoFontMap*" "fontmap")
-    '("const-char*" "atomname")
-  )
-)
-
-(define-function pango_x_fontmap_name_from_atom
-  (c-name "pango_x_fontmap_name_from_atom")
-  (return-type "const-char*")
-  (parameters
-    '("PangoFontMap*" "fontmap")
-    '("Atom" "atom")
-  )
-)
-
-
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]