gtk-doc r650 - in trunk: . tests/gobject/src

[stefkost svn gnome org]

Author: stefkost
Date: Tue Jan 20 20:46:50 2009
New Revision: 650
URL: http://svn.gnome.org/viewvc/gtk-doc?rev=650&view=rev

Log:
	* TODO:
	* gtkdoc-mkdb.in:
	* tests/gobject/src/gobject.c:
	  We could add the language as a comment, it is not shown in the final output.



Modified:
   trunk/ChangeLog
   trunk/TODO
   trunk/gtkdoc-mkdb.in
   trunk/tests/gobject/src/gobject.c

Modified: trunk/TODO
==============================================================================
--- trunk/TODO	(original)
+++ trunk/TODO	Tue Jan 20 20:46:50 2009
@@ -216,9 +216,17 @@
 <div class="informalexample"><pre class="programlisting"> is used for examples.
 problems:
 * in html we don't know the language anymore
+  * add another div
 * with source-highlight, constants and types are not markedup.
   for types we might need to build an own lang file dynamically and include
   /usr/share/source-highlight/c.lang
+=== |[ ... ]| does not allow setting the language ===
+* check for vi/emacs/jedit modelines
+  jedit: http://www.jedit.org/users-guide/buffer-local.html
+  vim: http://vim.wikia.com/wiki/Modeline_magic
+  emacs: http://www.delorie.com/gnu/docs/emacs/emacs_486.html
+* allow <!-- language="C" --> comments after |[
+* we need to catch those when processing the docbook and expanding the |[
 
 = documentation best practises #518427 =
 * we'd like offer a more complete skelleton

Modified: trunk/gtkdoc-mkdb.in
==============================================================================
--- trunk/gtkdoc-mkdb.in	(original)
+++ trunk/gtkdoc-mkdb.in	Tue Jan 20 20:46:50 2009
@@ -2298,6 +2298,8 @@
   # Convert "|[" and "]|" into the start and end of program listing examples.
   $text =~ s%\|\[%<informalexample><programlisting>%g;
   $text =~ s%\]\|%</programlisting></informalexample>%g;
+  # TODO: check for a xml comment after |[ and pick the language attribute from
+  # that
 
   # keep CDATA unmodified, preserve ulink tags (ideally we preseve all tags
   # as such)

Modified: trunk/tests/gobject/src/gobject.c
==============================================================================
--- trunk/tests/gobject/src/gobject.c	(original)
+++ trunk/tests/gobject/src/gobject.c	Tue Jan 20 20:46:50 2009
@@ -6,7 +6,8 @@
  * We can link to the #GtkdocObject:otest property and the #GtkdocObject::otest
  * signal.
  * A new instance can be created using the gtkdoc_object_new() function. The
- * whole lifecycle usualy looks like shown in this example: |[
+ * whole lifecycle usualy looks like shown in this example:
+ * |[<!-- language="C" -->
  * GObject *myobj;
  * 
  * myobj = gtkdoc_object_new();