SF.net SVN: geany: [2760] trunk
ntrel at users.sourceforge.net
ntrel at xxxxx
Mon Jul 7 13:08:21 UTC 2008
Revision: 2760
http://geany.svn.sourceforge.net/geany/?rev=2760&view=rev
Author: ntrel
Date: 2008-07-07 06:08:07 -0700 (Mon, 07 Jul 2008)
Log Message:
-----------
Rename plugin-symbols.c pluginsymbols.c.
Modified Paths:
--------------
trunk/ChangeLog
trunk/doc/Makefile.am
trunk/doc/plugins.dox
Added Paths:
-----------
trunk/doc/pluginsymbols.c
Removed Paths:
-------------
trunk/doc/plugin-symbols.c
Modified: trunk/ChangeLog
===================================================================
--- trunk/ChangeLog 2008-07-07 11:38:15 UTC (rev 2759)
+++ trunk/ChangeLog 2008-07-07 13:08:07 UTC (rev 2760)
@@ -5,6 +5,8 @@
* src/editor.c:
Make line breaking work with multi-line comment completion and
'Newline strips trailing spaces' pref.
+ * doc/plugin-symbols.c, doc/Makefile.am, doc/plugins.dox:
+ Rename plugin-symbols.c pluginsymbols.c.
2008-07-05 Enrico Tröger <enrico(dot)troeger(at)uvena(dot)de>
Modified: trunk/doc/Makefile.am
===================================================================
--- trunk/doc/Makefile.am 2008-07-07 11:38:15 UTC (rev 2759)
+++ trunk/doc/Makefile.am 2008-07-07 13:08:07 UTC (rev 2760)
@@ -1,7 +1,7 @@
man_MANS=geany.1
DOCDIR = $(DESTDIR)$(docdir)
IMAGE_FILES = images/*.png
-EXTRA_DIST = geany.html geany.css geany.txt geany.1 plugins.dox plugin-symbols.c \
+EXTRA_DIST = geany.html geany.css geany.txt geany.1 plugins.dox pluginsymbols.c \
$(srcdir)/$(IMAGE_FILES)
pdf: geany.txt
Deleted: trunk/doc/plugin-symbols.c
===================================================================
--- trunk/doc/plugin-symbols.c 2008-07-07 11:38:15 UTC (rev 2759)
+++ trunk/doc/plugin-symbols.c 2008-07-07 13:08:07 UTC (rev 2760)
@@ -1,94 +0,0 @@
-/*
- * plugin-symbols.c - this file is part of Geany, a fast and lightweight IDE
- *
- * Copyright 2008 Enrico Tröger <enrico(dot)troeger(at)uvena(dot)de>
- * Copyright 2008 Nick Treleaven <nick(dot)treleaven(at)btinternet(dot)com>
- *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2 of the License, or
- * (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
- * MA 02110-1301, USA.
- *
- * $Id$
- */
-
-/* Note: this file is for Doxygen only. */
-
-/**
- * @file plugin-symbols.c
- * Symbols declared from within plugins.
- *
- * Geany looks for these symbols (arrays, pointers and functions) when initializing
- * plugins. Some of them are optional, i.e. they can be omitted; others are required
- * and must be defined. Some symbols should only be declared using specific macros in
- * @link plugindata.h @endlink.
- */
-
-/** Use the PLUGIN_VERSION_CHECK() macro instead. Required by Geany. */
-gint plugin_version_check(gint);
-
-/** Use the PLUGIN_SET_INFO() macro to define it. Required by Geany.
- * This function is called before the plugin is initialized, so Geany
- * can read the plugin's name.
- * @param info The data struct which should be initialized by this function. */
-void plugin_set_info(PluginInfo *info);
-
-/** Basic information about a plugin, which is set in plugin_set_info(). */
-const PluginInfo* plugin_info;
-
-/** Geany owned data pointers.
- * Example: @c assert(geany_data->app->configdir != NULL); */
-const GeanyData* geany_data;
-
-/** Geany owned function pointers, split into groups.
- * Example: @c geany_functions->p_document->new_file(NULL, NULL, NULL);
- *
- * Note: Usually plugins would use the pluginmacros.h file and just call:
- * @c p_document->new_file(NULL, NULL, NULL); */
-const GeanyFunctions* geany_functions;
-
-/** Plugin owned fields, including flags. */
-PluginFields* plugin_fields;
-
-/** An array for connecting GeanyObject events, which should be terminated with
- * @c {NULL, NULL, FALSE, NULL}. See @link signals Signal documentation @endlink. */
-PluginCallback plugin_callbacks[];
-
-/** Most plugins should use the PLUGIN_KEY_GROUP() macro to define it. However,
- * its fields are not read until after plugin_init() is called for the plugin, so it
- * is possible to setup a variable number of keybindings, e.g. based on the
- * plugin's configuration file settings.
- * - The @c name field must not be empty or match Geany's default group name.
- * - The @c label field is set by Geany after plugin_init() is called to the name of the
- * plugin.
- * @note This is a single element array for implementation reasons,
- * but you can treat it like a pointer. */
-KeyBindingGroup plugin_key_group[1];
-
-
-/** Called before showing the plugin preferences dialog to let the user set some basic
- * plugin configuration options. Can be omitted when not needed.
- * @param dialog The plugin preferences dialog widget - this should only be used to
- * connect the @c "response" signal. If settings should be read from the dialog, the
- * reponse will be either @c GTK_RESPONSE_OK or @c GTK_RESPONSE_APPLY.
- * @return A container widget holding preference widgets. */
-GtkWidget* plugin_configure(GtkDialog *dialog);
-
-/** Called after loading the plugin.
- * @param data The same as #geany_data. */
-void plugin_init(GeanyData *data);
-
-/** Called before unloading the plugin. Required for normal plugins - it should undo
- * everything done in plugin_init() - e.g. destroy menu items, free memory. */
-void plugin_cleanup();
-
Modified: trunk/doc/plugins.dox
===================================================================
--- trunk/doc/plugins.dox 2008-07-07 11:38:15 UTC (rev 2759)
+++ trunk/doc/plugins.dox 2008-07-07 13:08:07 UTC (rev 2760)
@@ -42,7 +42,7 @@
*
* Other pages:
* - @link plugindata.h Main Datatypes and Macros @endlink
- * - @link plugin-symbols.c Plugin Symbols @endlink
+ * - @link pluginsymbols.c Plugin Symbols @endlink
* - @link pluginmacros.h Optional Macros @endlink
* - @link signals Plugin Signals @endlink
*
@@ -192,7 +192,7 @@
*
* Every plugin must contain some essential symbols unless it won't work. A complete
* list of all necessary and optional symbols can be found in
- * @link plugin-symbols.c Plugin Symbols @endlink.
+ * @link pluginsymbols.c Plugin Symbols @endlink.
* Every plugin should include "geany.h" and "plugindata.h" which provide necessary
* preprocessor macros and other basic information.
* There are two important preprocessor macros which need to be used at the beginning:
Copied: trunk/doc/pluginsymbols.c (from rev 2752, trunk/doc/plugin-symbols.c)
===================================================================
--- trunk/doc/pluginsymbols.c (rev 0)
+++ trunk/doc/pluginsymbols.c 2008-07-07 13:08:07 UTC (rev 2760)
@@ -0,0 +1,94 @@
+/*
+ * pluginsymbols.c - this file is part of Geany, a fast and lightweight IDE
+ *
+ * Copyright 2008 Enrico Tröger <enrico(dot)troeger(at)uvena(dot)de>
+ * Copyright 2008 Nick Treleaven <nick(dot)treleaven(at)btinternet(dot)com>
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
+ * MA 02110-1301, USA.
+ *
+ * $Id$
+ */
+
+/* Note: this file is for Doxygen only. */
+
+/**
+ * @file pluginsymbols.c
+ * Symbols declared from within plugins.
+ *
+ * Geany looks for these symbols (arrays, pointers and functions) when initializing
+ * plugins. Some of them are optional, i.e. they can be omitted; others are required
+ * and must be defined. Some symbols should only be declared using specific macros in
+ * @link plugindata.h @endlink.
+ */
+
+/** Use the PLUGIN_VERSION_CHECK() macro instead. Required by Geany. */
+gint plugin_version_check(gint);
+
+/** Use the PLUGIN_SET_INFO() macro to define it. Required by Geany.
+ * This function is called before the plugin is initialized, so Geany
+ * can read the plugin's name.
+ * @param info The data struct which should be initialized by this function. */
+void plugin_set_info(PluginInfo *info);
+
+/** Basic information about a plugin, which is set in plugin_set_info(). */
+const PluginInfo* plugin_info;
+
+/** Geany owned data pointers.
+ * Example: @c assert(geany_data->app->configdir != NULL); */
+const GeanyData* geany_data;
+
+/** Geany owned function pointers, split into groups.
+ * Example: @c geany_functions->p_document->new_file(NULL, NULL, NULL);
+ *
+ * Note: Usually plugins would use the pluginmacros.h file and just call:
+ * @c p_document->new_file(NULL, NULL, NULL); */
+const GeanyFunctions* geany_functions;
+
+/** Plugin owned fields, including flags. */
+PluginFields* plugin_fields;
+
+/** An array for connecting GeanyObject events, which should be terminated with
+ * @c {NULL, NULL, FALSE, NULL}. See @link signals Signal documentation @endlink. */
+PluginCallback plugin_callbacks[];
+
+/** Most plugins should use the PLUGIN_KEY_GROUP() macro to define it. However,
+ * its fields are not read until after plugin_init() is called for the plugin, so it
+ * is possible to setup a variable number of keybindings, e.g. based on the
+ * plugin's configuration file settings.
+ * - The @c name field must not be empty or match Geany's default group name.
+ * - The @c label field is set by Geany after plugin_init() is called to the name of the
+ * plugin.
+ * @note This is a single element array for implementation reasons,
+ * but you can treat it like a pointer. */
+KeyBindingGroup plugin_key_group[1];
+
+
+/** Called before showing the plugin preferences dialog to let the user set some basic
+ * plugin configuration options. Can be omitted when not needed.
+ * @param dialog The plugin preferences dialog widget - this should only be used to
+ * connect the @c "response" signal. If settings should be read from the dialog, the
+ * reponse will be either @c GTK_RESPONSE_OK or @c GTK_RESPONSE_APPLY.
+ * @return A container widget holding preference widgets. */
+GtkWidget* plugin_configure(GtkDialog *dialog);
+
+/** Called after loading the plugin.
+ * @param data The same as #geany_data. */
+void plugin_init(GeanyData *data);
+
+/** Called before unloading the plugin. Required for normal plugins - it should undo
+ * everything done in plugin_init() - e.g. destroy menu items, free memory. */
+void plugin_cleanup();
+
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
More information about the Commits
mailing list