Commit 2d57d53f authored by Juan Pablo Ugarte's avatar Juan Pablo Ugarte

removed every extra documentation, we keep them empty just because

* doc/tmpl/*.sgml: removed every extra documentation, we keep them empty just
  because otherwise the build fails.

* doc/gladeui-docs.sgml, doc/gladeui-sections.txt, doc/gladeui.types: updated
  (GladeWidgetClass  replaced by GladeWidgetAdaptor)

* gladeui/glade-editor.c, gladeui/glade-editor-property.c, gladeui/glade-parameter.c,
  gladeui/glade-widget.c, gladeui/glade-fixed.c, gladeui/glade-clipboard.c,
  gladeui/glade-inspector.[ch], gladeui/glade-widget-adaptor.[ch], gladeui/glade-command.c,
  gladeui/glade-command.h, gladeui/glade-base-editor.[ch], gladeui/glade-palette.[ch],
  gladeui/glade-utils.c, gladeui/glade-signal-editor.c, gladeui/glade-app.c,
  gladeui/glade-placeholder.c, gladeui/glade-property.c, gladeui/glade-property-class.c,
  gladeui/glade-project.c, gladeui/glade-clipboard-view.c:
  Added section's short and long description. (moved from tmpl)


svn path=/trunk/; revision=1523
parent e6e03f1b
2007-07-30 Juan Pablo Ugarte <juanpablougarte@gmail.com>
* doc/tmpl/*.sgml: removed every extra documentation, we keep them empty just
because otherwise the build fails.
* doc/gladeui-docs.sgml, doc/gladeui-sections.txt, doc/gladeui.types: updated
(GladeWidgetClass replaced by GladeWidgetAdaptor)
* gladeui/glade-editor.c, gladeui/glade-editor-property.c, gladeui/glade-parameter.c,
gladeui/glade-widget.c, gladeui/glade-fixed.c, gladeui/glade-clipboard.c,
gladeui/glade-inspector.[ch], gladeui/glade-widget-adaptor.[ch], gladeui/glade-command.c,
gladeui/glade-command.h, gladeui/glade-base-editor.[ch], gladeui/glade-palette.[ch],
gladeui/glade-utils.c, gladeui/glade-signal-editor.c, gladeui/glade-app.c,
gladeui/glade-placeholder.c, gladeui/glade-property.c, gladeui/glade-property-class.c,
gladeui/glade-project.c, gladeui/glade-clipboard-view.c:
Added section's short and long description. (moved from tmpl)
2006-07-30 Tristan Van Berkom <tvb@gnome.org>
* NEWS, configure.ac: Rolling 3.3.3
......
......@@ -20,7 +20,7 @@
<!ENTITY GladeProperty SYSTEM "xml/glade-property.xml">
<!ENTITY GladeSignalEditor SYSTEM "xml/glade-signal-editor.xml">
<!ENTITY GladeUtils SYSTEM "xml/glade-utils.xml">
<!ENTITY GladeWidgetClass SYSTEM "xml/glade-widget-class.xml">
<!ENTITY GladeWidgetAdaptor SYSTEM "xml/glade-widget-adaptor.xml">
<!ENTITY GladeWidget SYSTEM "xml/glade-widget.xml">
<!ENTITY GladeFixed SYSTEM "xml/glade-fixed.xml">
<!ENTITY GladeBaseEditor SYSTEM "xml/glade-base-editor.xml">
......@@ -62,7 +62,7 @@
&GladeWidget;
&GladeFixed;
&GladeProperty;
&GladeWidgetClass;
&GladeWidgetAdaptor;
&GladePropertyClass;
&GladeCommand;
&GladeClipboard;
......
This diff is collapsed.
......@@ -13,3 +13,4 @@ glade_project_get_type
glade_inspector_get_type
glade_property_get_type
glade_widget_get_type
glade_widget_adaptor_get_type
......@@ -2,14 +2,11 @@
GladeApp
<!-- ##### SECTION Short_Description ##### -->
The central control point of the Glade core
<!-- ##### SECTION Long_Description ##### -->
<para>
This main control object is where we try to draw the line between
what is the Glade core and what is the main application. The main
application must derive from the GladeApp object and create an instance
to initialize the Glade core.
</para>
<!-- ##### SECTION See_Also ##### -->
......@@ -20,6 +17,19 @@ to initialize the Glade core.
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### MACRO GLADE_TYPE_POINTER_MODE ##### -->
<para>
</para>
<!-- ##### STRUCT GladeAppPrivate ##### -->
<para>
</para>
<!-- ##### STRUCT GladeApp ##### -->
<para>
......@@ -43,6 +53,22 @@ to initialize the Glade core.
</para>
<!-- ##### FUNCTION glade_app_new ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION glade_pointer_mode_get_type ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION glade_app_get ##### -->
<para>
......@@ -106,6 +132,14 @@ to initialize the Glade core.
@Returns:
<!-- ##### FUNCTION glade_app_get_project ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION glade_app_set_project ##### -->
<para>
......@@ -114,7 +148,7 @@ to initialize the Glade core.
@project:
<!-- ##### FUNCTION glade_app_get_project ##### -->
<!-- ##### FUNCTION glade_app_get_pointer_mode ##### -->
<para>
</para>
......@@ -122,6 +156,14 @@ to initialize the Glade core.
@Returns:
<!-- ##### FUNCTION glade_app_set_pointer_mode ##### -->
<para>
</para>
@mode:
<!-- ##### FUNCTION glade_app_add_project ##### -->
<para>
......@@ -138,16 +180,15 @@ to initialize the Glade core.
@project:
<!-- ##### FUNCTION glade_app_get_project_by_path ##### -->
<!-- ##### FUNCTION glade_app_get_projects ##### -->
<para>
</para>
@project_path:
@Returns:
<!-- ##### FUNCTION glade_app_get_projects ##### -->
<!-- ##### FUNCTION glade_app_get_config ##### -->
<para>
</para>
......@@ -155,15 +196,16 @@ to initialize the Glade core.
@Returns:
<!-- ##### FUNCTION glade_app_get_config ##### -->
<!-- ##### FUNCTION glade_app_is_project_loaded ##### -->
<para>
</para>
@project_path:
@Returns:
<!-- ##### FUNCTION glade_app_is_project_loaded ##### -->
<!-- ##### FUNCTION glade_app_get_project_by_path ##### -->
<para>
</para>
......@@ -187,50 +229,50 @@ to initialize the Glade core.
<!-- ##### FUNCTION glade_app_command_undo ##### -->
<!-- ##### FUNCTION glade_app_command_copy ##### -->
<para>
</para>
<!-- ##### FUNCTION glade_app_command_redo ##### -->
<!-- ##### FUNCTION glade_app_command_cut ##### -->
<para>
</para>
<!-- ##### FUNCTION glade_app_command_copy ##### -->
<!-- ##### FUNCTION glade_app_command_paste ##### -->
<para>
</para>
@placeholder:
<!-- ##### FUNCTION glade_app_command_cut ##### -->
<!-- ##### FUNCTION glade_app_command_delete ##### -->
<para>
</para>
<!-- ##### FUNCTION glade_app_command_paste ##### -->
<!-- ##### FUNCTION glade_app_command_delete_clipboard ##### -->
<para>
</para>
@placeholder:
<!-- ##### FUNCTION glade_app_command_delete ##### -->
<!-- ##### FUNCTION glade_app_command_undo ##### -->
<para>
</para>
<!-- ##### FUNCTION glade_app_command_delete_clipboard ##### -->
<!-- ##### FUNCTION glade_app_command_redo ##### -->
<para>
</para>
......@@ -293,6 +335,32 @@ to initialize the Glade core.
@Returns:
<!-- ##### FUNCTION glade_app_get_selection ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION glade_app_is_selected ##### -->
<para>
</para>
@object:
@Returns:
<!-- ##### FUNCTION glade_app_selection_set ##### -->
<para>
</para>
@object:
@emit_signal:
<!-- ##### FUNCTION glade_app_selection_add ##### -->
<para>
......@@ -311,6 +379,14 @@ to initialize the Glade core.
@emit_signal:
<!-- ##### FUNCTION glade_app_selection_clear ##### -->
<para>
</para>
@emit_signal:
<!-- ##### FUNCTION glade_app_selection_changed ##### -->
<para>
......@@ -318,7 +394,7 @@ to initialize the Glade core.
<!-- ##### FUNCTION glade_app_get_selection ##### -->
<!-- ##### FUNCTION glade_app_get_catalogs_dir ##### -->
<para>
</para>
......@@ -326,29 +402,35 @@ to initialize the Glade core.
@Returns:
<!-- ##### FUNCTION glade_app_selection_clear ##### -->
<!-- ##### FUNCTION glade_app_get_modules_dir ##### -->
<para>
</para>
@emit_signal:
@Returns:
<!-- ##### FUNCTION glade_app_selection_set ##### -->
<!-- ##### FUNCTION glade_app_get_plugins_dir ##### -->
<para>
</para>
@object:
@emit_signal:
@Returns:
<!-- ##### FUNCTION glade_app_is_selected ##### -->
<!-- ##### FUNCTION glade_app_get_pixmaps_dir ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION glade_app_get_locale_dir ##### -->
<para>
</para>
@object:
@Returns:
<!-- ##### SECTION Title ##### -->
glade-base-editor
GladeBaseEditor
<!-- ##### SECTION Short_Description ##### -->
......@@ -17,6 +17,12 @@ glade-base-editor
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### STRUCT GladeBaseEditorPrivate ##### -->
<para>
</para>
<!-- ##### STRUCT GladeBaseEditor ##### -->
<para>
......@@ -36,24 +42,13 @@ glade-base-editor
@Returns:
<!-- ##### FUNCTION glade_base_editor_add_popup_items ##### -->
<para>
</para>
@editor:
@Varargs:
<!-- ##### FUNCTION glade_base_editor_pack_new_window ##### -->
<!-- ##### FUNCTION glade_base_editor_add_default_properties ##### -->
<para>
</para>
@editor:
@title:
@markup:
@Returns:
@gchild:
<!-- ##### FUNCTION glade_base_editor_add_properties ##### -->
......@@ -75,13 +70,13 @@ glade-base-editor
@str:
<!-- ##### FUNCTION glade_base_editor_add_default_properties ##### -->
<!-- ##### FUNCTION glade_base_editor_add_popup_items ##### -->
<para>
</para>
@editor:
@gchild:
@Varargs:
<!-- ##### FUNCTION glade_base_editor_set_show_signal_editor ##### -->
......@@ -93,3 +88,14 @@ glade-base-editor
@val:
<!-- ##### FUNCTION glade_base_editor_pack_new_window ##### -->
<para>
</para>
@editor:
@title:
@help_markup:
@Returns:
......@@ -2,13 +2,11 @@
GladeClipboardView
<!-- ##### SECTION Short_Description ##### -->
A widget to view and control the #GladeClipboard
<!-- ##### SECTION Long_Description ##### -->
<para>
The #GladeClipboardView is a widget to view the #GladeWidget objects
in the #GladeClipboard; the user can paste or delete objects on the
clipboard.
</para>
<!-- ##### SECTION See_Also ##### -->
......
......@@ -2,13 +2,11 @@
GladeClipboard
<!-- ##### SECTION Short_Description ##### -->
A list of #GladeWidget objects not in any #GladeProject
<!-- ##### SECTION Long_Description ##### -->
<para>
The #GladeClipboard is a singleton and is an accumulative shelf
of all cut or copied #GladeWidget in the application. A #GladeWidget
can be cut from one #GladeProject and pasted to another.
</para>
<!-- ##### SECTION See_Also ##### -->
......
<!-- ##### SECTION Title ##### -->
Glade Commands
GladeCommand
<!-- ##### SECTION Short_Description ##### -->
An event filter to implement the Undo/Redo stack
<!-- ##### SECTION Long_Description ##### -->
<para>
The Glade Command api allows us to view user actions as items and execute
and undo those items; each #GladeProject has its own Undo/Redo stack.
</para>
<!-- ##### SECTION See_Also ##### -->
......@@ -18,6 +17,37 @@ and undo those items; each #GladeProject has its own Undo/Redo stack.
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### STRUCT GCSetPropData ##### -->
<para>
</para>
@property:
@new_value:
@old_value:
<!-- ##### STRUCT GladeCommand ##### -->
<para>
</para>
<!-- ##### FUNCTION glade_command_push_group ##### -->
<para>
</para>
@fmt:
@Varargs:
<!-- ##### FUNCTION glade_command_pop_group ##### -->
<para>
</para>
<!-- ##### FUNCTION glade_command_execute ##### -->
<para>
......@@ -55,92 +85,82 @@ and undo those items; each #GladeProject has its own Undo/Redo stack.
@other:
<!-- ##### FUNCTION glade_command_push_group ##### -->
<!-- ##### FUNCTION glade_command_set_property ##### -->
<para>
</para>
@fmt:
@property:
@Varargs:
<!-- ##### FUNCTION glade_command_pop_group ##### -->
<!-- ##### FUNCTION glade_command_set_property_value ##### -->
<para>
</para>
@property:
@value:
<!-- ##### FUNCTION glade_command_set_name ##### -->
<!-- ##### FUNCTION glade_command_set_properties ##### -->
<para>
</para>
@glade_widget:
@name:
@property:
@old_value:
@new_value:
@Varargs:
<!-- ##### FUNCTION glade_command_create ##### -->
<!-- ##### FUNCTION glade_command_set_properties_list ##### -->
<para>
</para>
@adaptor:
@parent:
@placeholder:
@project:
@Returns:
@props:
<!-- ##### FUNCTION glade_command_delete ##### -->
<!-- ##### FUNCTION glade_command_set_name ##### -->
<para>
</para>
@widgets:
<!-- ##### STRUCT GCSetPropData ##### -->
<para>
#GladeProperties can be set in a list as one command,
for Undo purposes; we store the list of #GCSetPropData with
their old and new #GValue.
</para>
@glade_widget:
@name:
@property: A #GladeProperty to set
@new_value: The new #GValue to assign to @property
@old_value: The old #GValue of @property
<!-- ##### FUNCTION glade_command_set_property ##### -->
<!-- ##### FUNCTION glade_command_delete ##### -->
<para>
</para>
@property:
@Varargs:
@widgets:
<!-- ##### FUNCTION glade_command_set_properties ##### -->
<!-- ##### FUNCTION glade_command_create ##### -->
<para>
</para>
@property:
@old_value:
@new_value:
@Varargs:
@adaptor:
@parent:
@placeholder:
@project:
@Returns:
<!-- ##### FUNCTION glade_command_set_properties_list ##### -->
<!-- ##### FUNCTION glade_command_cut ##### -->
<para>
</para>
@project:
@props:
@widgets:
<!-- ##### FUNCTION glade_command_cut ##### -->
<!-- ##### FUNCTION glade_command_copy ##### -->
<para>
</para>
......@@ -148,15 +168,17 @@ their old and new #GValue.
@widgets:
<!-- ##### FUNCTION glade_command_copy ##### -->
<!-- ##### FUNCTION glade_command_paste ##### -->
<para>
</para>
@widgets:
@parent:
@placeholder:
<!-- ##### FUNCTION glade_command_paste ##### -->
<!-- ##### FUNCTION glade_command_dnd ##### -->
<para>
</para>
......@@ -190,7 +212,18 @@ their old and new #GValue.
</para>
@glade_widget:
@old:
@old_signal:
@new_signal:
<!-- ##### FUNCTION glade_command_set_i18n ##### -->
<para>
</para>
@property:
@translatable:
@has_context:
@comment:
<!-- ##### SECTION Title ##### -->
GladeDesignLayout
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### STRUCT GladeDesignLayoutPrivate ##### -->
<para>
</para>
<!-- ##### STRUCT GladeDesignLayout ##### -->
<para>
</para>
@parent_instance:
@priv:
<!-- ##### FUNCTION glade_design_layout_new ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION glade_design_layout_widget_event ##### -->
<para>
</para>
@layout:
@event_gwidget:
@event:
@Returns:
<!-- ##### SECTION Title ##### -->
GladeDesignView
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### STRUCT GladeDesignViewPrivate ##### -->
<para>
</para>
<!-- ##### STRUCT GladeDesignView ##### -->
<para>
</para>
@parent_instance:
@priv:
<!-- ##### FUNCTION glade_design_view_new ##### -->
<para>
</para>
@project:
@Returns:
<!-- ##### FUNCTION glade_design_view_get_project ##### -->
<para>
</para>
@view:
@Returns:
<!-- ##### FUNCTION glade_design_view_get_from_project ##### -->
<para>
</para>
@project:
@Returns:
<!-- ##### FUNCTION glade_design_view_get_layout ##### -->
<para>
</para>