SF.net SVN: geany:[4535] trunk/doc/plugins.dox

ntrel at users.sourceforge.net ntrel at xxxxx
Tue Jan 19 15:48:43 UTC 2010


Revision: 4535
          http://geany.svn.sourceforge.net/geany/?rev=4535&view=rev
Author:   ntrel
Date:     2010-01-19 15:48:42 +0000 (Tue, 19 Jan 2010)

Log Message:
-----------
Edit wording/section names.

Modified Paths:
--------------
    trunk/doc/plugins.dox

Modified: trunk/doc/plugins.dox
===================================================================
--- trunk/doc/plugins.dox	2010-01-18 17:17:34 UTC (rev 4534)
+++ trunk/doc/plugins.dox	2010-01-19 15:48:42 UTC (rev 4535)
@@ -481,25 +481,25 @@
 }
  *  @endcode
  *
+ *  If you think this plugin seems not to implement any functionality right now and only wastes
+ *  some memory, you are right. But it should compile and load/unload in Geany nicely.
+ *  Now you have the very basic layout of a new plugin. Great, isn't it?
+ *
  *  @section building Building
  *
+ *  First make plugin.o:
+ *
  *  @code gcc -c plugin.c -fPIC `pkg-config --cflags geany` @endcode
  *
- *  to make plugin.o, then:
+ *  Then make the plugin library plugin.so (or plugin.dll on Windows):
  *
  *  @code gcc plugin.o -o plugin.so -shared `pkg-config --libs geany` @endcode
  *
- *  to make the plugin library plugin.so (or plugin.dll on Windows).
+ *  If all went OK, put the library into one of the paths Geany looks for plugins,
+ *  e.g. $prefix/lib/geany. See @ref paths "Installation paths" for details.
  *
- *  Then just put the library into one of the paths Geany looks for plugins in, e.g. $prefix/lib/geany.
- *  See @ref paths "Installation paths" for details.
+ *  @section realfunc Adding functionality
  *
- *  @section realfunc Real functionality
- *
- *  If you think this plugin seems not to implement any functionality right now and only wastes
- *  some memory, you are right. But it should compile and load/unload in Geany nicely.
- *  Now you have the very basic layout of a new plugin. Great, isn't it?
- *
  *  Let's go on and implement some real functionality.
  *
  *  As mentioned before, plugin_init() will be called when the plugin is loaded in Geany.
@@ -573,7 +573,8 @@
  *  memory once your plugin is unloaded, so you don't leave any memory leaks.
  *  Once this is done, your first plugin is ready. Congratulations!
  *
- *  The complete listing (without comments):
+ *  @section listing Complete listing (without comments)
+ *
  *  @code
 #include "geanyplugin.h"
 


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