[libgdamm] Work around a doxygen crash.



commit 52d84d02356ee26547b6ab3105417773d4aa9267
Author: Murray Cumming <murrayc murrayc com>
Date:   Sat Oct 16 22:02:05 2010 +0200

    Work around a doxygen crash.
    
    * libgda/src/sqlparser.hg: Class overview documentation: Instead of
    describing the placeholder syntax, just link to the GdaSqlParser
    documentation. This is unavoidable as there seems to be now way to mention
    /* in a comment. The attempt to use @verbatim endverbatim to do this does
    not seem to have worked in the past and crashes current versions of doxygen.
    ( Doxygen bug https://bugzilla.gnome.org/show_bug.cgi?id=632311 )

 ChangeLog               |   11 +++++++++++
 libgda/src/sqlparser.hg |   18 +++---------------
 2 files changed, 14 insertions(+), 15 deletions(-)
---
diff --git a/ChangeLog b/ChangeLog
index 3f7904d..7688db2 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,16 @@
 2010-10-16  Murray Cumming  <murrayc murrayc com>
 
+	Work around a doxygen crash.
+
+	* libgda/src/sqlparser.hg: Class overview documentation: Instead of 
+	describing the placeholder syntax, just link to the GdaSqlParser 
+	documentation. This is unavoidable as there seems to be now way to mention 
+	/* in a comment. The attempt to use @verbatim endverbatim to do this does 
+	not seem to have worked in the past and crashes current versions of doxygen.  
+	( Doxygen bug https://bugzilla.gnome.org/show_bug.cgi?id=632311 )
+
+2010-10-16  Murray Cumming  <murrayc murrayc com>
+
 	Regenerated C documentation.
 
 	* libgda/src/libgda_docs.xml: Regenerated with docextract_to_xml.py.
diff --git a/libgda/src/sqlparser.hg b/libgda/src/sqlparser.hg
index 51be0e7..3960f7f 100644
--- a/libgda/src/sqlparser.hg
+++ b/libgda/src/sqlparser.hg
@@ -34,6 +34,7 @@ namespace Gda
 _WRAP_ENUM(SqlParserMode, GdaSqlParserMode)
 _WRAP_GERROR(SqlParserError, GdaSqlParserError, GDA_SQL_PARSER_ERROR)
 		
+//TODO: Find out how to escape /* so we can actually show the full syntax at the end of this text.
 /** SQL parser.
  *
  * The Gda::SqlParser is an object dedicated to creating Gda::Statement and 
@@ -69,21 +70,8 @@ _WRAP_GERROR(SqlParserError, GdaSqlParserError, GDA_SQL_PARSER_ERROR)
  * should be reported as a bug.
  *
  * The Gda::SqlParser object recognizes place holders (variables), which can later
- * be queried and valued using Gda::Statement::get_parameters(). The folllowing syntax 
- * are recognized (other syntaxes might be recognized for specific database 
- * providers if the Gda::SqlParser is created using Gda::ServerProvider::create_parser() 
- * but for portability reasons it's better to avoid them):
- *
- * - ##NAME[::TYPE[::NULL]]: for a variable named NAME with the optional type TYPE 
- * (which can be a GType name or a custom database type name), and with the 
- * optional "::NULL" to instruct that the variable can be NULL.
- * - ## //@verbatim endverbatim* name:NAME [type:TYPE] [nullok:[TRUE|FALSE]] [descr:DESCR] * verbatim@endverbatim/
- * for a variable named NAME with the optional type TYPE (which can be a GType 
- * name or a custom database type name), with the optional "nullok" attribute 
- * and an optional description DESCR. Note that the NAME, TYPE and DESCR literals here 
- * must be quoted (simple or double quotes) if they include non alphanumeric 
- * characters, and that there must always be at least a space between the 
- * ## and the //@verbatim endverbatim* ... * verbatim@endverbatim/.
+ * be queried and valued using Gda::Statement::get_parameters(). 
+ * See the syntax description for the underlying <a href="http://library.gnome.org/devel/libgda/stable/GdaSqlParser.html#GdaSqlParser.description";>GdaSqlParser</a>.
  *
  * @ingroup Connection
  */



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]