HybridDog/geany
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Fix typos in plugin documentation

Browse Source
This commit is contained in:
Philipp Wiesemann 2016-04-09 23:25:25 +02:00
parent 3967ce582f
commit ad81720d98
3 changed files with 16 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
doc/plugins.dox
View File

@ -95,10 +95,10 @@ All information about this project you can find at http://plugins.geany.org/
To add a new plugin to this project, get in touch with the people on the To add a new plugin to this project, get in touch with the people on the
geany-devel-mailing list and create a fork of the geany-plugins project geany-devel-mailing list and create a fork of the geany-plugins project
at https://github.com/geany/geany-plugins. at https://github.com/geany/geany-plugins.
Beside of adding a new plugin, geany-devel-mailing list is also the place where Beside of adding a new plugin, geany-devel-mailing list is also the place
to discuss development related questions. to discuss development related questions.
However, once you have done your fork of geany-plugins you can develop However, once you have done your fork of geany-plugins you can develop
your plugin until you think its the right time to publish it. At this point, your plugin until you think it is the right time to publish it. At this point,
create a pull request for adding your patch set into the master branch of the main create a pull request for adding your patch set into the master branch of the main
geany-plugins repository. geany-plugins repository.
@ -170,7 +170,7 @@ distributions, the package names and commands to use may differ.
Basically, you are done at this point and could continue with writing the plugin code. Basically, you are done at this point and could continue with writing the plugin code.
[1] For Windows, it is basically the same but you might have some more work on setting up [1] For Windows, it is basically the same but you might have some more work on setting up
the general build environment(compiler, GTK development files, ...). This is described on the general build environment (compiler, GTK development files, ...). This is described on
Geany's website at http://www.geany.org/Support/BuildingOnWin32. Geany's website at http://www.geany.org/Support/BuildingOnWin32.
@section helloworld "Hello World" @section helloworld "Hello World"
@ -207,7 +207,7 @@ that helps supporting GTK+2 and GTK+3 in the same source.
Now you can go on and write your first lines for your new plugin. As mentioned before, you will Now you can go on and write your first lines for your new plugin. As mentioned before, you will
need to implement a couple of functions. The first mandatory one is @a geany_load_module(). Geany need to implement a couple of functions. The first mandatory one is @a geany_load_module(). Geany
uses the presence fo this function to identify a library as a plugin. When Geany scans the uses the presence of this function to identify a library as a plugin. When Geany scans the
pre-defined and user-configured plugin directories, it will take a look at each shared library (or pre-defined and user-configured plugin directories, it will take a look at each shared library (or
DLL on Windows) to see if it exports a @a geany_load_module() symbol. Files lacking these will be DLL on Windows) to see if it exports a @a geany_load_module() symbol. Files lacking these will be
ignored. The second mandatory one is an initialization function that is only called when the plugin ignored. The second mandatory one is an initialization function that is only called when the plugin
@ -577,7 +577,7 @@ static gboolean hello_init(GeanyPlugin *plugin, gpointer pdata)
This page briefly describes the deprecated, legacy plugin entry points. These have been in place This page briefly describes the deprecated, legacy plugin entry points. These have been in place
prior to Geany 1.26 and are still loadable and working for the time being. However, do not create prior to Geany 1.26 and are still loadable and working for the time being. However, do not create
new plugins against these. For this reason, the actual description here is rather minimalistic and new plugins against these. For this reason, the actual description here is rather minimalistic and
concentrates on porting legacy plugins to the new interface. Basically it's main purpose concentrates on porting legacy plugins to the new interface. Basically its main purpose
is to give newcomers an idea of what they are looking at if they come across a legacy plugin. is to give newcomers an idea of what they are looking at if they come across a legacy plugin.
@section overview Overview @section overview Overview
@ -595,10 +595,10 @@ plugin_configure_single(GtkWidget *) are optional, however Geany prints a warnin
plugin_cleanup() is missing and only one of plugin_configure(GtkDialog *) and plugin_cleanup() is missing and only one of plugin_configure(GtkDialog *) and
plugin_configure_single(GtkWidget *) is used for any single plugin. plugin_configure_single(GtkWidget *) is used for any single plugin.
By convention, plugin_version_check() is implicitely defined through the use of PLUGIN_VERSION_CHECK(), By convention, plugin_version_check() is implicitly defined through the use of PLUGIN_VERSION_CHECK(),
and similarly plugin_info is defined through PLUGIN_SET_INFO() or PLUGIN_SET_TRANSLATABLE_INFO(). and similarly plugin_info is defined through PLUGIN_SET_INFO() or PLUGIN_SET_TRANSLATABLE_INFO().
The functions should generally perform the same tasks as their eqivalents in GeanyPlugin::funcs. The functions should generally perform the same tasks as their equivalents in GeanyPlugin::funcs.
Geany also recognized numerous variable fields if the plugin exported them globally, and actually Geany also recognized numerous variable fields if the plugin exported them globally, and actually
set a few of them inside the plugins data section. set a few of them inside the plugins data section.
@ -759,7 +759,7 @@ sub-plugin plugins in an abstract manner:
- Unloading simply reverses the effect of loading. - Unloading simply reverses the effect of loading.
For providing these methods, GeanyPlugin has a field GeanyProxyFuncs which contains three function For providing these methods, GeanyPlugin has a field GeanyProxyFuncs which contains three function
pointers which must be initialized proir to calling geany_plugin_register_proxy(). This should be pointers which must be initialized prior to calling geany_plugin_register_proxy(). This should be
done in the GeanyPluginFuncs::init function of the proxy plugin. done in the GeanyPluginFuncs::init function of the proxy plugin.
- In the call to geany_plugin_register_proxy() the proxy plugin passes a list of file extensions. - In the call to geany_plugin_register_proxy() the proxy plugin passes a list of file extensions.
@ -769,7 +769,7 @@ done in the GeanyPluginFuncs::init function of the proxy plugin.
provided file extensions) is actually a plugin. This may depend on the plugin file itself in provided file extensions) is actually a plugin. This may depend on the plugin file itself in
case of ambiguity or availability of runtime dependencies or even configuration. case of ambiguity or availability of runtime dependencies or even configuration.
@ref PROXY_IGNORED or @ref PROXY_MATCHED should be returned, possibly in combination @ref PROXY_IGNORED or @ref PROXY_MATCHED should be returned, possibly in combination
with the @ref PROXY_NOLOAD flag. Not implementing GeanyProxyFuncs::probe at all is eqivalent to with the @ref PROXY_NOLOAD flag. Not implementing GeanyProxyFuncs::probe at all is equivalent to
always returning @ref PROXY_MATCHED. always returning @ref PROXY_MATCHED.
- GeanyProxyFuncs::load must be implemented to actually load the plugin. It is called by Geany - GeanyProxyFuncs::load must be implemented to actually load the plugin. It is called by Geany
when the user enables the sub-plugin. What "loading" means is entirely up to the proxy plugin and when the user enables the sub-plugin. What "loading" means is entirely up to the proxy plugin and
@ -843,7 +843,7 @@ syntactic problems or other errors.
There are two basic classes: There are two basic classes:
1) Runtime errors that can be determined at load time. For example, the shebang of a script 1) Runtime errors that can be determined at load time. For example, the shebang of a script
indicates a specific interpeter version but that version is not installed on the system. Your proxy indicates a specific interpreter version but that version is not installed on the system. Your proxy
should respond the same way as for version-incompatible plugins: don't register the plugin at should respond the same way as for version-incompatible plugins: don't register the plugin at
all, but leave a message the user suggesting what has to be installed in order to work. Handle all, but leave a message the user suggesting what has to be installed in order to work. Handle
syntax errors in the scripts of sub-plugins the same way if possible. syntax errors in the scripts of sub-plugins the same way if possible.
@ -973,7 +973,7 @@ static gint demoproxy_probe(GeanyPlugin *proxy, const gchar *filename, gpointer
GeanyProxyFuncs::load is a bit more complex. It reads the file, fills the sub-plugin's PluginInfo GeanyProxyFuncs::load is a bit more complex. It reads the file, fills the sub-plugin's PluginInfo
fields and calls GEANY_PLUGIN_REGISTER_FULL(). Additionally, it creates a per-plugin context that fields and calls GEANY_PLUGIN_REGISTER_FULL(). Additionally, it creates a per-plugin context that
holds GKeyFile instance (a poor man's interpeter context). You can also see that it does not call holds GKeyFile instance (a poor man's interpreter context). You can also see that it does not call
GEANY_PLUGIN_REGISTER_FULL() if g_key_file_load_from_file() found an error (probably a syntax GEANY_PLUGIN_REGISTER_FULL() if g_key_file_load_from_file() found an error (probably a syntax
problem) which means the sub-plugin cannot be enabled. problem) which means the sub-plugin cannot be enabled.

8
doc/pluginsignals.c
View File

@ -135,18 +135,18 @@ signal void (*document_close)(GObject *obj, GeanyDocument *doc, gpointer user_da
/** Sent after a project is opened but before session files are loaded. /** Sent after a project is opened but before session files are loaded.
* *
* @param obj a GeanyObject instance, should be ignored. * @param obj a GeanyObject instance, should be ignored.
* @param config an exising GKeyFile object which can be used to read and write data. * @param config an existing GKeyFile object which can be used to read and write data.
* It must not be closed or freed. * It must not be closed or freed.
* @param user_data user data. * @param user_data user data.
*/ */
signal void (*project_open)(GObject *obj, GKeyFile *config, gpointer user_data); signal void (*project_open)(GObject *obj, GKeyFile *config, gpointer user_data);
/** Sent when a project is saved(happens when the project is created, the properties /** Sent when a project is saved (happens when the project is created, the properties
* dialog is closed or Geany is exited). This signal is emitted shortly before Geany * dialog is closed or Geany is exited). This signal is emitted shortly before Geany
* will write the contents of the GKeyFile to the disc. * will write the contents of the GKeyFile to the disc.
* *
* @param obj a GeanyObject instance, should be ignored. * @param obj a GeanyObject instance, should be ignored.
* @param config an exising GKeyFile object which can be used to read and write data. * @param config an existing GKeyFile object which can be used to read and write data.
* It must not be closed or freed. * It must not be closed or freed.
* @param user_data user data. * @param user_data user data.
*/ */
@ -242,7 +242,7 @@ signal void (*update_editor_menu)(GObject *obj, const gchar *word, gint pos, Gea
* The signal can be sent after Geany's default handler has been run when you set * The signal can be sent after Geany's default handler has been run when you set
* PluginCallback::after field to TRUE. * PluginCallback::after field to TRUE.
* *
* An example callback implemention of this signal can be found in the Demo plugin. * An example callback implementation of this signal can be found in the Demo plugin.
* *
* @warning This signal has much power and should be used carefully. You should especially * @warning This signal has much power and should be used carefully. You should especially
* care about the return value; make sure to return TRUE only if it is necessary * care about the return value; make sure to return TRUE only if it is necessary

2
doc/pluginsymbols.c
View File

@ -111,7 +111,7 @@ void plugin_init(GeanyData *data);
void plugin_cleanup(); void plugin_cleanup();
/** Called whenever the plugin should show its documentation (if any). This may open a dialog, /** Called whenever the plugin should show its documentation (if any). This may open a dialog,
* a browser with a website or a local installed HTML help file(see utils_open_browser()) * a browser with a website or a local installed HTML help file (see utils_open_browser())
* or something else. * or something else.
* Can be omitted when not needed. */ * Can be omitted when not needed. */
void plugin_help(); void plugin_help();