SF.net SVN: geany:[4126] trunk

[ntrel at users.sourceforge.net]

Revision: 4126
          http://geany.svn.sourceforge.net/geany/?rev=4126&view=rev
Author:   ntrel
Date:     2009-08-26 14:42:25 +0000 (Wed, 26 Aug 2009)

Log Message:
-----------
Add warning about not using undocumented features.
Add reference to HACKING for plugin API development.

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

Modified: trunk/ChangeLog
===================================================================
--- trunk/ChangeLog	2009-08-25 21:33:04 UTC (rev 4125)
+++ trunk/ChangeLog	2009-08-26 14:42:25 UTC (rev 4126)
@@ -1,3 +1,10 @@
+2009-08-26  Nick Treleaven  <nick(dot)treleaven(at)btinternet(dot)com>
+
+ * doc/plugins.dox:
+   Add warning about not using undocumented features.
+   Add reference to HACKING for plugin API development.
+
+
 2009-08-25  Enrico Tröger  <enrico(dot)troeger(at)uvena(dot)de>
 
  * tagmanager/php.c:

Modified: trunk/doc/plugins.dox
===================================================================
--- trunk/doc/plugins.dox	2009-08-25 21:33:04 UTC (rev 4125)
+++ trunk/doc/plugins.dox	2009-08-26 14:42:25 UTC (rev 4126)
@@ -29,26 +29,29 @@
 
 /**
  *
- *  @mainpage Geany Plugin API Documentation
+ * @mainpage Geany Plugin API Documentation
  *
- *  @author Enrico Tröger, Nick Treleaven, Frank Lanitz
- *  @date $Date$
+ * @author Enrico Tröger, Nick Treleaven, Frank Lanitz
+ * @date $Date$
  *
- *  @section Intro
- *  This is the Geany API documentation. It is far from being complete and should be
- *  considered as a work in progress.
- *  We will try to document as many functions and structs as possible.
+ * @section Intro
+ * This is the Geany API documentation. It is far from being complete and should be
+ * considered as a work in progress.
+ * We will try to document as many functions and structs as possible.
  *
- *  To get started, see the @link howto Plugin Howto @endlink.
+ * To get started, see the @link howto Plugin Howto @endlink.
  *
- *  Other pages:
- *  - @link pluginsymbols.c Plugin Symbols @endlink
- *  - @link plugindata.h Main Datatypes and Macros @endlink
- *  - @link signals Plugin Signals @endlink
- *  - @link pluginutils.c Plugin Utility Functions @endlink
- *  - @link guidelines Plugin Writing Guidelines @endlink
+ * Other pages:
+ * - @link pluginsymbols.c Plugin Symbols @endlink
+ * - @link plugindata.h Main Datatypes and Macros @endlink
+ * - @link signals Plugin Signals @endlink
+ * - @link pluginutils.c Plugin Utility Functions @endlink
+ * - @link guidelines Plugin Writing Guidelines @endlink
  *
- *  @note Some of these pages are also listed in Related Pages.
+ * @note Some of these pages are also listed in Related Pages, plus the list of deprecated symbols.
+ * @warning Do not use anything not documented here, it may change.
+ * @note You should see the HACKING file for information about developing the plugin API and
+ * other useful things.
  */
 
 /**


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