gedit r6809 - in trunk: docs/reference docs/reference/tmpl gedit

[pborelli svn gnome org]

Author: pborelli
Date: Mon Jan  5 18:04:39 2009
New Revision: 6809
URL: http://svn.gnome.org/viewvc/gedit?rev=6809&view=rev

Log:
fix some gtk-doc errors


Modified:
   trunk/docs/reference/Makefile.am
   trunk/docs/reference/gedit-docs.sgml
   trunk/docs/reference/tmpl/gedit-message-bus.sgml
   trunk/docs/reference/tmpl/gedit-message-type.sgml
   trunk/gedit/gedit-plugin.c
   trunk/gedit/gedit-view.c

Modified: trunk/docs/reference/Makefile.am
==============================================================================
--- trunk/docs/reference/Makefile.am	(original)
+++ trunk/docs/reference/Makefile.am	Mon Jan  5 18:04:39 2009
@@ -69,14 +69,7 @@
 IGNORE_HFILES +=	\
 	bacon-message-connection.h		\
 	gedittextregion.h			\
-	sexy-icon-entry.h			\
-	egg-recent-item.h			\
-	egg-recent-model.h			\
-	egg-recent-util.h			\
-	egg-recent-view-gtk.h			\
-	egg-recent-view.h			\
-	egg-recent-view-uimanager.h
-
+	sexy-icon-entry.h
 
 # Images to copy into HTML directory.
 HTML_IMAGES=

Modified: trunk/docs/reference/gedit-docs.sgml
==============================================================================
--- trunk/docs/reference/gedit-docs.sgml	(original)
+++ trunk/docs/reference/gedit-docs.sgml	Mon Jan  5 18:04:39 2009
@@ -33,7 +33,6 @@
     <xi:include href="xml/gedit-metadata-manager.xml"/>
     <xi:include href="xml/gedit-prefs-manager-app.xml"/>
     <xi:include href="xml/gedit-prefs-manager.xml"/>
-    <xi:include href="xml/gedit-recent.xml"/>
     <xi:include href="xml/gedit-utils.xml"/>
   </chapter>
 </book>

Modified: trunk/docs/reference/tmpl/gedit-message-bus.sgml
==============================================================================
--- trunk/docs/reference/tmpl/gedit-message-bus.sgml	(original)
+++ trunk/docs/reference/tmpl/gedit-message-bus.sgml	Mon Jan  5 18:04:39 2009
@@ -126,6 +126,16 @@
 @Returns: 
 
 
+<!-- ##### FUNCTION gedit_message_bus_foreach ##### -->
+<para>
+
+</para>
+
+ bus: 
+ func: 
+ userdata: 
+
+
 <!-- ##### FUNCTION gedit_message_bus_connect ##### -->
 <para>
 

Modified: trunk/docs/reference/tmpl/gedit-message-type.sgml
==============================================================================
--- trunk/docs/reference/tmpl/gedit-message-type.sgml	(original)
+++ trunk/docs/reference/tmpl/gedit-message-type.sgml	Mon Jan  5 18:04:39 2009
@@ -50,6 +50,15 @@
 @Returns: 
 
 
+<!-- ##### FUNCTION gedit_message_type_is_valid_object_path ##### -->
+<para>
+
+</para>
+
+ object_path: 
+ Returns: 
+
+
 <!-- ##### FUNCTION gedit_message_type_new ##### -->
 <para>
 

Modified: trunk/gedit/gedit-plugin.c
==============================================================================
--- trunk/gedit/gedit-plugin.c	(original)
+++ trunk/gedit/gedit-plugin.c	Mon Jan  5 18:04:39 2009
@@ -178,7 +178,10 @@
  * gedit_plugin_get_install_dir:
  * @plugin: a #GeditPlugin
  *
- * Returns the path of the directory where the plugin is installed
+ * Get the path of the directory where the plugin is installed.
+ *
+ * Return value: a newly allocated string with the path of the
+ * directory where the plugin is installed
  */
 gchar *
 gedit_plugin_get_install_dir (GeditPlugin *plugin)
@@ -192,8 +195,11 @@
  * gedit_plugin_get_data_dir:
  * @plugin: a #GeditPlugin
  *
- * Returns the path of the directory where the plugin should look for
- * its data files
+ * Get the path of the directory where the plugin should look for
+ * its data files.
+ *
+ * Return value: a newly allocated string with the path of the
+ * directory where the plugin should look for its data files
  */
 gchar *
 gedit_plugin_get_data_dir (GeditPlugin *plugin)

Modified: trunk/gedit/gedit-view.c
==============================================================================
--- trunk/gedit/gedit-view.c	(original)
+++ trunk/gedit/gedit-view.c	Mon Jan  5 18:04:39 2009
@@ -583,6 +583,13 @@
 				      0.0);
 }
 
+/**
+ * gedit_view_delete_selection:
+ * @view: a #GeditView
+ * 
+ * Deletes the text currently selected in the #GtkTextBuffer associated
+ * to the view and scroll to the cursor position.
+ **/
 void
 gedit_view_delete_selection (GeditView *view)
 {
@@ -609,6 +616,12 @@
 				      0.0);
 }
 
+/**
+ * gedit_view_select_all:
+ * @view: a #GeditView
+ * 
+ * Selects all the text displayed in the @view.
+ **/
 void
 gedit_view_select_all (GeditView *view)
 {
@@ -626,6 +639,12 @@
 	gtk_text_buffer_select_range (buffer, &start, &end);
 }
 
+/**
+ * gedit_view_scroll_to_cursor:
+ * @view: a #GeditView
+ * 
+ * Scrolls the @view to the cursor position.
+ **/
 void
 gedit_view_scroll_to_cursor (GeditView *view)
 {
@@ -646,6 +665,15 @@
 				      0.0);
 }
 
+/**
+ * gedit_view_set_font:
+ * @view: a #GeditView
+ * @gboolean: whether to reset the default font
+ * @font_name: the name of the font to use
+ * 
+ * If @def is #TRUE, resets the font of the @view to the default font
+ * otherwise sets it to @font_name.
+ **/
 void
 gedit_view_set_font (GeditView   *view, 
 		     gboolean     def,