gnomemm r1895 - in gstreamermm/trunk: . tools/extra_defs_gen

[jaalburqu svn gnome org]

Author: jaalburqu
Date: Fri Dec 19 22:03:16 2008
New Revision: 1895
URL: http://svn.gnome.org/viewvc/gnomemm?rev=1895&view=rev

Log:
2008-12-19  Josà Alburquerque  <jaalburqu svn gnome org>

	* tools/extra_defs_gen/generate_plugin_gmmproc_file.cc: Added warning
	to plug-in Doxygen blocks (class docs) that using the underlying C
	*type* of the wrapped plug-in is not guaranteed to be API stable
	across releases.

Modified:
   gstreamermm/trunk/ChangeLog
   gstreamermm/trunk/tools/extra_defs_gen/generate_plugin_gmmproc_file.cc

Modified: gstreamermm/trunk/tools/extra_defs_gen/generate_plugin_gmmproc_file.cc
==============================================================================
--- gstreamermm/trunk/tools/extra_defs_gen/generate_plugin_gmmproc_file.cc	(original)
+++ gstreamermm/trunk/tools/extra_defs_gen/generate_plugin_gmmproc_file.cc	Fri Dec 19 22:03:16 2008
@@ -388,7 +388,12 @@
   std::cout << enumWrapStatements << std::endl;
 
   std::cout << "/** " << nmspace << "::" << cppTypeName << " â " << pluginName << " plugin." << std::endl;
-  std::cout << " * Please include <" << target << "/" << cppTypeName.lowercase() << ".h> to use." << std::endl;
+  std::cout << " * Please include <" << target << "/" <<
+    cppTypeName.lowercase() << ".h> to use.  Also, though using the\n"
+    " * underlying GObject is fine, using its C <B>type</B> is not "
+    "guaranteed to be\n * API stable across releases because it is not "
+    "guaranteed to always remain\n * the same." << std::endl;
+  std::cout << " *" << std::endl;
   std::cout << " * @ingroup " << nmspace << "Plugins" << std::endl;
   std::cout << " */" << std::endl;
   std::cout << "class " << cppTypeName << std::endl;