SF.net SVN: geany:[4365] trunk

[ntrel at users.sourceforge.net]

Revision: 4365
          http://geany.svn.sourceforge.net/geany/?rev=4365&view=rev
Author:   ntrel
Date:     2009-10-26 12:58:52 +0000 (Mon, 26 Oct 2009)

Log Message:
-----------
Add missing dox for types/files in the API.

Modified Paths:
--------------
    trunk/ChangeLog
    trunk/src/prefs.h
    trunk/src/search.h
    trunk/src/support.h
    trunk/src/templates.h
    trunk/src/toolbar.c
    trunk/src/toolbar.h

Modified: trunk/ChangeLog
===================================================================
--- trunk/ChangeLog	2009-10-25 22:43:15 UTC (rev 4364)
+++ trunk/ChangeLog	2009-10-26 12:58:52 UTC (rev 4365)
@@ -1,3 +1,10 @@
+2009-10-26  Nick Treleaven  <nick(dot)treleaven(at)btinternet(dot)com>
+
+ * src/prefs.h, src/search.h, src/support.h, src/templates.h,
+   src/toolbar.c, src/toolbar.h:
+   Add missing dox for types/files in the API.
+
+
 2009-10-25  Enrico Tröger  <enrico(dot)troeger(at)uvena(dot)de>
 
  * plugins/saveactions.c:

Modified: trunk/src/prefs.h
===================================================================
--- trunk/src/prefs.h	2009-10-25 22:43:15 UTC (rev 4364)
+++ trunk/src/prefs.h	2009-10-26 12:58:52 UTC (rev 4365)
@@ -20,22 +20,27 @@
  *
  */
 
+/**
+ * @file prefs.h
+ * Preferences dialog.
+ **/
 
+
 #ifndef GEANY_PREFS_H
 #define GEANY_PREFS_H 1
 
-/* General Preferences dialog settings. */
+/** General Preferences dialog settings. */
 typedef struct GeanyPrefs
 {
 	gboolean		load_session;
 	gboolean		load_plugins;
 	gboolean		save_winpos;
 	gboolean		confirm_exit;
-	gboolean		beep_on_errors;
+	gboolean		beep_on_errors;		/* use utils_beep() instead */
 	gboolean		suppress_status_messages;
 	gboolean		switch_to_status;
 	gboolean		auto_focus;
-	gchar			*default_open_path;
+	gchar			*default_open_path;	/**< Default path to look for files when no other path is appropriate. */
 	gchar			*custom_plugin_path;
 }
 GeanyPrefs;

Modified: trunk/src/search.h
===================================================================
--- trunk/src/search.h	2009-10-25 22:43:15 UTC (rev 4364)
+++ trunk/src/search.h	2009-10-26 12:58:52 UTC (rev 4365)
@@ -21,7 +21,12 @@
  * $Id$
  */
 
+/**
+ * @file search.h
+ * Search (prefs).
+ **/
 
+
 #ifndef GEANY_SEARCH_H
 #define GEANY_SEARCH_H 1
 
@@ -40,10 +45,11 @@
 extern GeanySearchData search_data;
 
 
+/** Search preferences */
 typedef struct GeanySearchPrefs
 {
 	gboolean	suppress_dialogs;
-	gboolean	use_current_word;
+	gboolean	use_current_word;		/**< Use current word for default search text */
 	gboolean	use_current_file_dir;	/* find in files directory to use on showing dialog */
 }
 GeanySearchPrefs;

Modified: trunk/src/support.h
===================================================================
--- trunk/src/support.h	2009-10-25 22:43:15 UTC (rev 4364)
+++ trunk/src/support.h	2009-10-26 12:58:52 UTC (rev 4365)
@@ -21,6 +21,13 @@
  * $Id$
  */
 
+/**
+ * @file support.h
+ * Defines internationalization macros.
+ * @see GLib's @c gi18n-lib.h.
+ **/
+
+
 #include "geany.h"
 
 #ifdef GETTEXT_PACKAGE

Modified: trunk/src/templates.h
===================================================================
--- trunk/src/templates.h	2009-10-25 22:43:15 UTC (rev 4364)
+++ trunk/src/templates.h	2009-10-26 12:58:52 UTC (rev 4365)
@@ -21,6 +21,12 @@
  * $Id$
  */
 
+/**
+ * @file templates.h
+ * Templates (prefs).
+ **/
+
+
 #ifndef GEANY_TEMPLATES_H
 #define GEANY_TEMPLATES_H 1
 
@@ -35,13 +41,14 @@
 };
 
 
+/** Template preferences. */
 typedef struct GeanyTemplatePrefs
 {
-	gchar			*developer;
-	gchar			*company;
-	gchar			*mail;
-	gchar			*initials;
-	gchar			*version;
+	gchar			*developer;	/**< Name */
+	gchar			*company;	/**< Company */
+	gchar			*mail;		/**< Email */
+	gchar			*initials;	/**< Initials */
+	gchar			*version;	/**< Initial version */
 	gchar			*year_format;
 	gchar			*date_format;
 	gchar			*datetime_format;

Modified: trunk/src/toolbar.c
===================================================================
--- trunk/src/toolbar.c	2009-10-25 22:43:15 UTC (rev 4364)
+++ trunk/src/toolbar.c	2009-10-26 12:58:52 UTC (rev 4365)
@@ -499,6 +499,7 @@
 	/* sets the icon style of the toolbar */
 	switch (toolbar_prefs.icon_style)
 	{
+		default:
 		case GTK_TOOLBAR_BOTH:
 		{
 			/*gtk_check_menu_item_set_active(GTK_CHECK_MENU_ITEM(ui_lookup_widget(main_widgets.window, "images_and_text1")), TRUE);*/

Modified: trunk/src/toolbar.h
===================================================================
--- trunk/src/toolbar.h	2009-10-25 22:43:15 UTC (rev 4364)
+++ trunk/src/toolbar.h	2009-10-26 12:58:52 UTC (rev 4365)
@@ -21,15 +21,21 @@
  * $Id$
  */
 
+/**
+ * @file toolbar.h
+ * Toolbar (prefs).
+ **/
+
+
 #ifndef GEANY_TOOLBAR_H
 #define GEANY_TOOLBAR_H
 
-
+/** Toolbar settings. */
 typedef struct GeanyToolbarPrefs
 {
 	gboolean		visible;
 	GtkIconSize		icon_size;
-	gint			icon_style;
+	GtkToolbarStyle	icon_style;	/**< Icon style. */
 	gboolean		append_to_menu;
 }
 GeanyToolbarPrefs;


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.