Add descriptions for all .c source files below the file header.

git-svn-id: https://geany.svn.sourceforge.net/svnroot/geany/trunk@1329 ea778897-0a13-0410-b9d1-a72fbfd435f5

ChangeLog

@@ -1,3 +1,9 @@
+2007-02-24  Nick Treleaven  <nick.treleaven@btinternet.com>
+
+ * src/*.c:
+   Add descriptions for all .c source files below the file header.
+
+
 2007-02-23  Nick Treleaven  <nick.treleaven@btinternet.com>
 
  * src/keyfile.c, src/document.c, src/document.h, src/main.c:

src/about.c

@@ -21,6 +21,10 @@
  * $Id$
  */
 
+/*
+ * About dialog and credits.
+ */
+
 #include "about.h"
 #include "geany.h"
 #include "utils.h"

src/build.c

@@ -21,6 +21,9 @@
  * $Id$
  */
 
+/*
+ * Build commands and menu items.
+ */
 
 #include "geany.h"
 #include "build.h"

src/callbacks.c

@@ -21,6 +21,10 @@
  * $Id$
  */
 
+/*
+ * Callbacks used by Glade. These are mainly in response to menu item and button events in the
+ * main window. Callbacks not used by Glade should go elsewhere.
+ */
 
 #include "geany.h"
 

src/dialogs.c

@@ -21,6 +21,10 @@
  * $Id$
  */
 
+/*
+ * General dialogs.
+ */
+
 #include "geany.h"
 
 #include <gdk/gdkkeysyms.h>

src/document.c

@@ -21,6 +21,11 @@
  * $Id$
  */
 
+/*
+ * Document related actions: new, save, open, etc.
+ * Also Scintilla search actions.
+ */
+
 #include "geany.h"
 
 #ifdef TIME_WITH_SYS_TIME

src/encodings.c

@@ -21,6 +21,9 @@
  *  $Id$
  */
 
+/*
+ * Encoding conversion and Byte Order Mark (BOM) handling.
+ */
 
 /*
  * Modified by the gedit Team, 2002. See the gedit AUTHORS file for a

src/filetypes.c

@@ -21,6 +21,9 @@
  * $Id$
  */
 
+/*
+ * Filetype detection, file extensions and filetype menu items.
+ */
 
 #include <string.h>
 

src/gb.c

@@ -21,6 +21,10 @@
  * $Id$
  */
 
+/*
+ * GTK-Bandit.
+ */
+
 #include <stdlib.h>
 #include <string.h>
 #include <time.h>
@@ -68,7 +72,7 @@ static void create_window(void)
 	GtkWidget *button5;
 
 	gb_window = gtk_window_new(GTK_WINDOW_TOPLEVEL);
-	gtk_window_set_title(GTK_WINDOW(gb_window), "Happy Eastern!");
+	gtk_window_set_title(GTK_WINDOW(gb_window), "Happy Easter!");
 	gtk_window_set_resizable(GTK_WINDOW(gb_window), FALSE);
 	gtk_window_set_position(GTK_WINDOW(gb_window), GTK_WIN_POS_CENTER);
 	gtk_window_set_destroy_with_parent(GTK_WINDOW(gb_window), TRUE);

src/highlighting.c

@@ -21,6 +21,10 @@
  * $Id$
  */
 
+/*
+ * Syntax highlighting for the different filetypes, using the Scintilla lexers.
+ */
+
 #include <stdlib.h>
 
 #include "SciLexer.h"

src/images.c

@@ -20,6 +20,9 @@
  *
  */
 
+/*
+ * Inline image data.
+ */
 
 /* GdkPixbuf RGBA C-Source image dump */
 #include <gtk/gtk.h>

src/keybindings.c

@@ -21,6 +21,9 @@
  * $Id$
  */
 
+/*
+ * Configurable keyboard shortcuts.
+ */
 
 #include <gdk/gdkkeysyms.h>
 

src/keyfile.c

@@ -21,6 +21,10 @@
  * $Id$
  */
 
+/*
+ * geany.conf preferences file loading and saving.
+ */
+
 #include <stdlib.h>
 #include <string.h>
 

src/main.c

@@ -21,6 +21,9 @@
  * $Id$
  */
 
+/*
+ * Program initialization and cleanup.
+ */
 
 #include <signal.h>
 #include <time.h>

src/msgwindow.c

@@ -21,6 +21,10 @@
  * $Id$
  */
 
+/*
+ * Message window functions (status, compiler, messages windows).
+ * Also compiler error message parsing and grep file and line parsing.
+ */
 
 #include <time.h>
 

src/notebook.c

@@ -21,6 +21,10 @@
  * $Id$
  */
 
+/*
+ * Notebook tab Drag 'n' Drop reordering and tab management.
+ */
+
 #include "geany.h"
 #include "notebook.h"
 #include "document.h"

src/prefs.c

@@ -21,6 +21,9 @@
  * $Id$
  */
 
+/*
+ * Preferences dialog support functions.
+ */
 
 #include <stdlib.h>
 #include <string.h>

src/project.c

@@ -21,6 +21,10 @@
  * $Id$
  */
 
+/*
+ * Project Management.
+ */
+
 #include "geany.h"
 
 #include <string.h>

src/sci_cb.c

@@ -21,6 +21,12 @@
  * $Id$
  */
 
+/*
+ * Callbacks for the Scintilla widget (ScintillaObject).
+ * Most important is the sci-notify callback, handled in on_editor_notification().
+ * This includes auto-indentation, comments, auto-completion, calltips, etc.
+ * Also some general Scintilla-related functions.
+ */
 
 #include <ctype.h>
 #include <string.h>

src/sciwrappers.c

@@ -21,6 +21,11 @@
  * $Id$
  */
 
+/*
+ * Wrappers for the SCI_* Scintilla messages.
+ * Originally from the cssed project (http://cssed.sf.net).
+ */
+
 #include <string.h>
 
 #include "geany.h"

src/search.c

@@ -21,6 +21,11 @@
  * $Id$
  */
 
+/*
+ * Find, Replace, Find in Files dialog related functions.
+ * Note that the basic text find functions are in document.c.
+ */
+
 #include <gdk/gdkkeysyms.h>
 
 #include "geany.h"

src/socket.c

@@ -1,5 +1,5 @@
 /*
- *      socket.h - this file is part of Geany, a fast and lightweight IDE
+ *      socket.c - this file is part of Geany, a fast and lightweight IDE
  *
  *      Copyright 2006-2007 Enrico Tröger <enrico.troeger@uvena.de>
  *      Copyright 2006-2007 Nick Treleaven <nick.treleaven@btinternet.com>
@@ -21,6 +21,12 @@
  * $Id$
  */
 
+/*
+ * Socket setup and messages handling.
+ * The socket allows detection and messages to be sent to the first running instance of Geany.
+ * Only the first instance loads session files at startup, and opens files from the command-line.
+ */
+
 /*
  * Little dev doc:
  * Each command which is sent between two instances (see send_open_command and

src/symbols.c

@@ -21,6 +21,13 @@
  * $Id$
  */
 
+/*
+ * Tagmanager related convenience functions.
+ * Tagmanager parses tags in the current documents, known as the workspace, plus global tags,
+ * which are lists of tags for each filetype. Global tags are loaded when a document with a
+ * matching filetype is first loaded.
+ */
+
 #include "geany.h"
 
 #include <ctype.h>

src/templates.c

@@ -21,6 +21,11 @@
  * $Id$
  */
 
+/*
+ * Templates to insert into the current document, or filetype templates to create a new
+ * document from.
+ */
+
 #include <time.h>
 #include <string.h>
 

src/tools.c

@@ -21,6 +21,10 @@
  * $Id$
  */
 
+/*
+ * Miscellaneous code for the Tools menu items.
+ */
+
 #include "geany.h"
 
 #include "support.h"

src/treeviews.c

@@ -21,6 +21,10 @@
  * $Id$
  */
 
+/*
+ * Sidebar related code for the Symbol list and Open files GtkTreeViews.
+ */
+
 #include <string.h>
 
 #include "geany.h"

src/ui_utils.c

@@ -21,6 +21,9 @@
  * $Id$
  */
 
+/*
+ * User Interface general utility functions.
+ */
 
 #include "geany.h"
 

src/utils.c

@@ -21,6 +21,9 @@
  * $Id$
  */
 
+/*
+ * General utility functions, non-GTK related.
+ */
 
 #include "SciLexer.h"
 #include "geany.h"

src/vte.c

@@ -21,6 +21,10 @@
  * $Id$
  */
 
+/*
+ * Virtual Terminal Emulation setup and handling code, using the libvte plugin library.
+ */
+
 #include "geany.h"
 
 #ifdef HAVE_VTE

src/win32.c

@@ -21,8 +21,9 @@
  *  $Id$
  */
 
-
-// special functions for the win32 platform
+/*
+ * Special functions for the win32 platform, to provide native dialogs.
+ */
 
 #include "geany.h"