Revision: 1329 http://svn.sourceforge.net/geany/?rev=1329&view=rev Author: ntrel Date: 2007-02-24 03:41:56 -0800 (Sat, 24 Feb 2007)
Log Message: ----------- Add descriptions for all .c source files below the file header.
Modified Paths: -------------- trunk/ChangeLog trunk/src/about.c trunk/src/build.c trunk/src/callbacks.c trunk/src/dialogs.c trunk/src/document.c trunk/src/encodings.c trunk/src/filetypes.c trunk/src/gb.c trunk/src/highlighting.c trunk/src/images.c trunk/src/keybindings.c trunk/src/keyfile.c trunk/src/main.c trunk/src/msgwindow.c trunk/src/notebook.c trunk/src/prefs.c trunk/src/project.c trunk/src/sci_cb.c trunk/src/sciwrappers.c trunk/src/search.c trunk/src/socket.c trunk/src/symbols.c trunk/src/templates.c trunk/src/tools.c trunk/src/treeviews.c trunk/src/ui_utils.c trunk/src/utils.c trunk/src/vte.c trunk/src/win32.c
Modified: trunk/ChangeLog =================================================================== --- trunk/ChangeLog 2007-02-23 16:15:42 UTC (rev 1328) +++ trunk/ChangeLog 2007-02-24 11:41:56 UTC (rev 1329) @@ -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:
Modified: trunk/src/about.c =================================================================== --- trunk/src/about.c 2007-02-23 16:15:42 UTC (rev 1328) +++ trunk/src/about.c 2007-02-24 11:41:56 UTC (rev 1329) @@ -21,6 +21,10 @@ * $Id$ */
+/* + * About dialog and credits. + */ + #include "about.h" #include "geany.h" #include "utils.h"
Modified: trunk/src/build.c =================================================================== --- trunk/src/build.c 2007-02-23 16:15:42 UTC (rev 1328) +++ trunk/src/build.c 2007-02-24 11:41:56 UTC (rev 1329) @@ -21,6 +21,9 @@ * $Id$ */
+/* + * Build commands and menu items. + */
#include "geany.h" #include "build.h"
Modified: trunk/src/callbacks.c =================================================================== --- trunk/src/callbacks.c 2007-02-23 16:15:42 UTC (rev 1328) +++ trunk/src/callbacks.c 2007-02-24 11:41:56 UTC (rev 1329) @@ -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"
Modified: trunk/src/dialogs.c =================================================================== --- trunk/src/dialogs.c 2007-02-23 16:15:42 UTC (rev 1328) +++ trunk/src/dialogs.c 2007-02-24 11:41:56 UTC (rev 1329) @@ -21,6 +21,10 @@ * $Id$ */
+/* + * General dialogs. + */ + #include "geany.h"
#include <gdk/gdkkeysyms.h>
Modified: trunk/src/document.c =================================================================== --- trunk/src/document.c 2007-02-23 16:15:42 UTC (rev 1328) +++ trunk/src/document.c 2007-02-24 11:41:56 UTC (rev 1329) @@ -21,6 +21,11 @@ * $Id$ */
+/* + * Document related actions: new, save, open, etc. + * Also Scintilla search actions. + */ + #include "geany.h"
#ifdef TIME_WITH_SYS_TIME
Modified: trunk/src/encodings.c =================================================================== --- trunk/src/encodings.c 2007-02-23 16:15:42 UTC (rev 1328) +++ trunk/src/encodings.c 2007-02-24 11:41:56 UTC (rev 1329) @@ -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
Modified: trunk/src/filetypes.c =================================================================== --- trunk/src/filetypes.c 2007-02-23 16:15:42 UTC (rev 1328) +++ trunk/src/filetypes.c 2007-02-24 11:41:56 UTC (rev 1329) @@ -21,6 +21,9 @@ * $Id$ */
+/* + * Filetype detection, file extensions and filetype menu items. + */
#include <string.h>
Modified: trunk/src/gb.c =================================================================== --- trunk/src/gb.c 2007-02-23 16:15:42 UTC (rev 1328) +++ trunk/src/gb.c 2007-02-24 11:41:56 UTC (rev 1329) @@ -21,6 +21,10 @@ * $Id$ */
+/* + * GTK-Bandit. + */ + #include <stdlib.h> #include <string.h> #include <time.h> @@ -68,7 +72,7 @@ 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);
Modified: trunk/src/highlighting.c =================================================================== --- trunk/src/highlighting.c 2007-02-23 16:15:42 UTC (rev 1328) +++ trunk/src/highlighting.c 2007-02-24 11:41:56 UTC (rev 1329) @@ -21,6 +21,10 @@ * $Id$ */
+/* + * Syntax highlighting for the different filetypes, using the Scintilla lexers. + */ + #include <stdlib.h>
#include "SciLexer.h"
Modified: trunk/src/images.c =================================================================== --- trunk/src/images.c 2007-02-23 16:15:42 UTC (rev 1328) +++ trunk/src/images.c 2007-02-24 11:41:56 UTC (rev 1329) @@ -20,6 +20,9 @@ * */
+/* + * Inline image data. + */
/* GdkPixbuf RGBA C-Source image dump */ #include <gtk/gtk.h>
Modified: trunk/src/keybindings.c =================================================================== --- trunk/src/keybindings.c 2007-02-23 16:15:42 UTC (rev 1328) +++ trunk/src/keybindings.c 2007-02-24 11:41:56 UTC (rev 1329) @@ -21,6 +21,9 @@ * $Id$ */
+/* + * Configurable keyboard shortcuts. + */
#include <gdk/gdkkeysyms.h>
Modified: trunk/src/keyfile.c =================================================================== --- trunk/src/keyfile.c 2007-02-23 16:15:42 UTC (rev 1328) +++ trunk/src/keyfile.c 2007-02-24 11:41:56 UTC (rev 1329) @@ -21,6 +21,10 @@ * $Id$ */
+/* + * geany.conf preferences file loading and saving. + */ + #include <stdlib.h> #include <string.h>
Modified: trunk/src/main.c =================================================================== --- trunk/src/main.c 2007-02-23 16:15:42 UTC (rev 1328) +++ trunk/src/main.c 2007-02-24 11:41:56 UTC (rev 1329) @@ -21,6 +21,9 @@ * $Id$ */
+/* + * Program initialization and cleanup. + */
#include <signal.h> #include <time.h>
Modified: trunk/src/msgwindow.c =================================================================== --- trunk/src/msgwindow.c 2007-02-23 16:15:42 UTC (rev 1328) +++ trunk/src/msgwindow.c 2007-02-24 11:41:56 UTC (rev 1329) @@ -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>
Modified: trunk/src/notebook.c =================================================================== --- trunk/src/notebook.c 2007-02-23 16:15:42 UTC (rev 1328) +++ trunk/src/notebook.c 2007-02-24 11:41:56 UTC (rev 1329) @@ -21,6 +21,10 @@ * $Id$ */
+/* + * Notebook tab Drag 'n' Drop reordering and tab management. + */ + #include "geany.h" #include "notebook.h" #include "document.h"
Modified: trunk/src/prefs.c =================================================================== --- trunk/src/prefs.c 2007-02-23 16:15:42 UTC (rev 1328) +++ trunk/src/prefs.c 2007-02-24 11:41:56 UTC (rev 1329) @@ -21,6 +21,9 @@ * $Id$ */
+/* + * Preferences dialog support functions. + */
#include <stdlib.h> #include <string.h>
Modified: trunk/src/project.c =================================================================== --- trunk/src/project.c 2007-02-23 16:15:42 UTC (rev 1328) +++ trunk/src/project.c 2007-02-24 11:41:56 UTC (rev 1329) @@ -21,6 +21,10 @@ * $Id$ */
+/* + * Project Management. + */ + #include "geany.h"
#include <string.h>
Modified: trunk/src/sci_cb.c =================================================================== --- trunk/src/sci_cb.c 2007-02-23 16:15:42 UTC (rev 1328) +++ trunk/src/sci_cb.c 2007-02-24 11:41:56 UTC (rev 1329) @@ -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>
Modified: trunk/src/sciwrappers.c =================================================================== --- trunk/src/sciwrappers.c 2007-02-23 16:15:42 UTC (rev 1328) +++ trunk/src/sciwrappers.c 2007-02-24 11:41:56 UTC (rev 1329) @@ -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"
Modified: trunk/src/search.c =================================================================== --- trunk/src/search.c 2007-02-23 16:15:42 UTC (rev 1328) +++ trunk/src/search.c 2007-02-24 11:41:56 UTC (rev 1329) @@ -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"
Modified: trunk/src/socket.c =================================================================== --- trunk/src/socket.c 2007-02-23 16:15:42 UTC (rev 1328) +++ trunk/src/socket.c 2007-02-24 11:41:56 UTC (rev 1329) @@ -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 @@ -22,6 +22,12 @@ */
/* + * 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 * socket_lock_input_cb) should have the following scheme:
Modified: trunk/src/symbols.c =================================================================== --- trunk/src/symbols.c 2007-02-23 16:15:42 UTC (rev 1328) +++ trunk/src/symbols.c 2007-02-24 11:41:56 UTC (rev 1329) @@ -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>
Modified: trunk/src/templates.c =================================================================== --- trunk/src/templates.c 2007-02-23 16:15:42 UTC (rev 1328) +++ trunk/src/templates.c 2007-02-24 11:41:56 UTC (rev 1329) @@ -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>
Modified: trunk/src/tools.c =================================================================== --- trunk/src/tools.c 2007-02-23 16:15:42 UTC (rev 1328) +++ trunk/src/tools.c 2007-02-24 11:41:56 UTC (rev 1329) @@ -21,6 +21,10 @@ * $Id$ */
+/* + * Miscellaneous code for the Tools menu items. + */ + #include "geany.h"
#include "support.h"
Modified: trunk/src/treeviews.c =================================================================== --- trunk/src/treeviews.c 2007-02-23 16:15:42 UTC (rev 1328) +++ trunk/src/treeviews.c 2007-02-24 11:41:56 UTC (rev 1329) @@ -21,6 +21,10 @@ * $Id$ */
+/* + * Sidebar related code for the Symbol list and Open files GtkTreeViews. + */ + #include <string.h>
#include "geany.h"
Modified: trunk/src/ui_utils.c =================================================================== --- trunk/src/ui_utils.c 2007-02-23 16:15:42 UTC (rev 1328) +++ trunk/src/ui_utils.c 2007-02-24 11:41:56 UTC (rev 1329) @@ -21,6 +21,9 @@ * $Id$ */
+/* + * User Interface general utility functions. + */
#include "geany.h"
Modified: trunk/src/utils.c =================================================================== --- trunk/src/utils.c 2007-02-23 16:15:42 UTC (rev 1328) +++ trunk/src/utils.c 2007-02-24 11:41:56 UTC (rev 1329) @@ -21,6 +21,9 @@ * $Id$ */
+/* + * General utility functions, non-GTK related. + */
#include "SciLexer.h" #include "geany.h"
Modified: trunk/src/vte.c =================================================================== --- trunk/src/vte.c 2007-02-23 16:15:42 UTC (rev 1328) +++ trunk/src/vte.c 2007-02-24 11:41:56 UTC (rev 1329) @@ -21,6 +21,10 @@ * $Id$ */
+/* + * Virtual Terminal Emulation setup and handling code, using the libvte plugin library. + */ + #include "geany.h"
#ifdef HAVE_VTE
Modified: trunk/src/win32.c =================================================================== --- trunk/src/win32.c 2007-02-23 16:15:42 UTC (rev 1328) +++ trunk/src/win32.c 2007-02-24 11:41:56 UTC (rev 1329) @@ -21,9 +21,10 @@ * $Id$ */
+/* + * Special functions for the win32 platform, to provide native dialogs. + */
-// special functions for the win32 platform - #include "geany.h"
#ifdef G_OS_WIN32
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.