SF.net SVN: geany:[4112] trunk

[ntrel at users.sourceforge.net]

Revision: 4112
          http://geany.svn.sourceforge.net/geany/?rev=4112&view=rev
Author:   ntrel
Date:     2009-08-20 12:16:28 +0000 (Thu, 20 Aug 2009)

Log Message:
-----------
Add geanyfunctions.h to API docs.

Modified Paths:
--------------
    trunk/ChangeLog
    trunk/doc/Doxyfile.in
    trunk/plugins/geanyfunctions.h
    trunk/plugins/genapi.py

Modified: trunk/ChangeLog
===================================================================
--- trunk/ChangeLog	2009-08-18 23:45:32 UTC (rev 4111)
+++ trunk/ChangeLog	2009-08-20 12:16:28 UTC (rev 4112)
@@ -1,3 +1,9 @@
+2009-08-20  Nick Treleaven  <nick(dot)treleaven(at)btinternet(dot)com>
+
+ * doc/Doxyfile.in, plugins/geanyfunctions.h, plugins/genapi.py:
+   Add geanyfunctions.h to API docs.
+
+
 2009-08-18  Nick Treleaven  <nick(dot)treleaven(at)btinternet(dot)com>
 
  * src/callbacks.c:

Modified: trunk/doc/Doxyfile.in
===================================================================
--- trunk/doc/Doxyfile.in	2009-08-18 23:45:32 UTC (rev 4111)
+++ trunk/doc/Doxyfile.in	2009-08-20 12:16:28 UTC (rev 4112)
@@ -94,7 +94,8 @@
 #---------------------------------------------------------------------------
 # configuration options related to the input files
 #---------------------------------------------------------------------------
-INPUT                  = ../src/ ./ ../plugins/pluginmacros.h ../plugins/geanyplugin.h \
+INPUT                  = ../src/ ./ \
+                         ../plugins/pluginmacros.h ../plugins/geanyplugin.h ../plugins/geanyfunctions.h \
                          ../tagmanager/tm_source_file.c ../tagmanager/include/tm_source_file.h \
                          ../tagmanager/tm_work_object.c ../tagmanager/include/tm_work_object.h \
                          ../tagmanager/tm_workspace.c ../tagmanager/include/tm_workspace.h
@@ -228,7 +229,7 @@
 INCLUDE_PATH           =
 INCLUDE_FILE_PATTERNS  =
 # make G_GNUC_PRINTF a no-op unless doxygen would ignore functions with varargs
-PREDEFINED             = "G_GNUC_PRINTF(x,y)=" GEANY_DISABLE_DEPRECATED HAVE_PLUGINS
+PREDEFINED             = "G_GNUC_PRINTF(x,y)=" GEANY_DISABLE_DEPRECATED HAVE_PLUGINS GEANY_FUNCTIONS_H
 EXPAND_AS_DEFINED      =
 SKIP_FUNCTION_MACROS   = NO
 #---------------------------------------------------------------------------

Modified: trunk/plugins/geanyfunctions.h
===================================================================
--- trunk/plugins/geanyfunctions.h	2009-08-18 23:45:32 UTC (rev 4111)
+++ trunk/plugins/geanyfunctions.h	2009-08-20 12:16:28 UTC (rev 4112)
@@ -1,10 +1,16 @@
-/* This file is generated automatically by genapi.py - do not edit.
+/* This file is generated automatically by genapi.py - do not edit. */
+
+/** @file geanyfunctions.h @ref geany_functions wrappers.
+ * This allows the use of normal API function names in plugins by defining macros.
  *
- * @file geanyfunctions.h @ref geany_functions wrappers.
- * This allows the use of normal API function names in plugins.
+ * E.g.:@code
+ * #define plugin_add_toolbar_item \
+ * 	geany_functions->p_plugin->add_toolbar_item @endcode
+ *
  * You need to declare the @ref geany_functions symbol yourself.
  *
- * Note: This must be included after all other API headers.
+ * Note: This must be included after all other API headers to prevent conflicts with
+ * other header's function prototypes - this is done for you when using geanyplugin.h.
  */
 
 #ifndef GEANY_FUNCTIONS_H

Modified: trunk/plugins/genapi.py
===================================================================
--- trunk/plugins/genapi.py	2009-08-18 23:45:32 UTC (rev 4111)
+++ trunk/plugins/genapi.py	2009-08-20 12:16:28 UTC (rev 4112)
@@ -26,7 +26,7 @@
 Creates macros for each plugin API function pointer, e.g.:
 
 #define plugin_add_toolbar_item \
-	p_plugin->add_toolbar_item
+	geany_functions->p_plugin->add_toolbar_item
 """
 
 
@@ -56,13 +56,19 @@
 
 
 header = \
-'''/* This file is generated automatically by genapi.py - do not edit.
+r'''/* This file is generated automatically by genapi.py - do not edit. */
+
+/** @file %s @ref geany_functions wrappers.
+ * This allows the use of normal API function names in plugins by defining macros.
  *
- * @file %s @ref geany_functions wrappers.
- * This allows the use of normal API function names in plugins.
+ * E.g.:@code
+ * #define plugin_add_toolbar_item \
+ * 	geany_functions->p_plugin->add_toolbar_item @endcode
+ *
  * You need to declare the @ref geany_functions symbol yourself.
  *
- * Note: This must be included after all other API headers.
+ * Note: This must be included after all other API headers to prevent conflicts with
+ * other header's function prototypes - this is done for you when using geanyplugin.h.
  */
 
 #ifndef GEANY_FUNCTIONS_H


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