Add geanyfunctions.h to API docs.

git-svn-id: https://geany.svn.sourceforge.net/svnroot/geany/trunk@4112 ea778897-0a13-0410-b9d1-a72fbfd435f5

ChangeLog

@@ -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:

doc/Doxyfile.in

@@ -94,7 +94,8 @@ WARN_LOGFILE           =
 #---------------------------------------------------------------------------
 # 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 @@ SEARCH_INCLUDES        = NO
 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
 #---------------------------------------------------------------------------

plugins/geanyfunctions.h

@@ -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.
+ *
+ * E.g.:@code
+ * #define plugin_add_toolbar_item \
+ * 	geany_functions->p_plugin->add_toolbar_item @endcode
  *
- * @file geanyfunctions.h @ref geany_functions wrappers.
- * This allows the use of normal API function names in plugins.
  * 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

plugins/genapi.py

@@ -26,7 +26,7 @@ r"""
 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 @@ def get_api_tuple(str):
 
 
 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.
+ *
+ * E.g.:@code
+ * #define plugin_add_toolbar_item \
+ * 	geany_functions->p_plugin->add_toolbar_item @endcode
  *
- * @file %s @ref geany_functions wrappers.
- * This allows the use of normal API function names in plugins.
  * 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