Revision: 3522 http://geany.svn.sourceforge.net/geany/?rev=3522&view=rev Author: eht16 Date: 2009-01-28 17:55:58 +0000 (Wed, 28 Jan 2009)

Log Message: ----------- Mention necessary header includes in the plugin signal descriptions. Add missing header includes for the demoplugin.

Modified Paths: -------------- trunk/ChangeLog trunk/doc/plugins.dox trunk/plugins/demoplugin.c

Modified: trunk/ChangeLog =================================================================== --- trunk/ChangeLog 2009-01-28 17:22:34 UTC (rev 3521) +++ trunk/ChangeLog 2009-01-28 17:55:58 UTC (rev 3522) @@ -11,6 +11,9 @@ Use the selection 'changed' signal of the treeview to update the popup menu items and show the popup menu on mouse button press events so right clicking on items will select them first. + * doc/plugins.dox, plugins/demoplugin.h: + Mention necessary header includes in the plugin signal descriptions. + Add missing header includes for the demoplugin.

2009-01-27 Enrico Tröger <enrico(dot)troeger(at)uvena(dot)de>

Modified: trunk/doc/plugins.dox =================================================================== --- trunk/doc/plugins.dox 2009-01-28 17:22:34 UTC (rev 3521) +++ trunk/doc/plugins.dox 2009-01-28 17:55:58 UTC (rev 3522) @@ -83,6 +83,9 @@ * @endsignalproto * @signaldesc * Sent when a new %document is created. + * + * You need to include "document.h" for the declaration of GeanyDocument. + * * @param obj a GeanyObject instance, should be ignored. * @param doc the new document. * @param user_data user data. @@ -94,6 +97,9 @@ * @endsignalproto * @signaldesc * Sent when a new %document is opened. + * + * You need to include "document.h" for the declaration of GeanyDocument. + * * @param obj a GeanyObject instance, should be ignored. * @param doc the opened document. * @param user_data user data. @@ -105,6 +111,9 @@ * @endsignalproto * @signaldesc * Sent when a new %document is saved. + * + * You need to include "document.h" for the declaration of GeanyDocument. + * * @param obj a GeanyObject instance, should be ignored. * @param doc the saved document. * @param user_data user data. @@ -116,6 +125,9 @@ * @endsignalproto * @signaldesc * Sent when switching notebook pages. + * + * You need to include "document.h" for the declaration of GeanyDocument. + * * @param obj a GeanyObject instance, should be ignored. * @param doc the current document. * @param user_data user data. @@ -127,6 +139,9 @@ * @endsignalproto * @signaldesc * Sent before closing a document. + * + * You need to include "document.h" for the declaration of GeanyDocument. + * * @param obj a GeanyObject instance, should be ignored. * @param doc the document about to be closed. * @param user_data user data. @@ -176,8 +191,12 @@ * @signaldesc * Sent before the popup menu of the editing widget is shown. This can be used to modify or extend * the popup menu. + * * @note You can add menu items from @c plugin_init() using @c geany->main_widgets->editor_menu, * remembering to destroy them in @c plugin_cleanup(). + * + * You need to include "document.h" for the declaration of GeanyDocument. + * * @param obj a GeanyObject instance, should be ignored. * @param word the current word (in UTF-8 encoding) below the cursor position where the popup menu will be opened. @@ -215,6 +234,9 @@ * care about the return value; make sure to return TRUE only if it is necessary * and in the correct situations. * + * You need to include "editor.h" for the declaration of GeanyEditor and "Scintilla.h" for + * SCNotification. + * * @param obj a GeanyObject instance, should be ignored. * @param editor The current GeanyEditor. * @param nt A pointer to the SCNotification struct which holds additional information for

Modified: trunk/plugins/demoplugin.c =================================================================== --- trunk/plugins/demoplugin.c 2009-01-28 17:22:34 UTC (rev 3521) +++ trunk/plugins/demoplugin.c 2009-01-28 17:55:58 UTC (rev 3522) @@ -37,8 +37,11 @@

#include "geany.h" /* for the GeanyApp data type */ #include "support.h" /* for the _() translation macro (see also po/POTFILES.in) */ +#include "editor.h" /* for the declaration of the GeanyEditor struct, not strictly necessary + as it will be also included by plugindata.h */ +#include "document.h" /* for the declaration of the GeanyDocument struct */ #include "ui_utils.h" -#include "Scintilla.h" /* for the SCNotification struct */ +#include "Scintilla.h" /* for the SCNotification struct */

#include "plugindata.h" /* this defines the plugin API */ #include "geanyfunctions.h" /* this wraps geany_functions function pointers */

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