Author: wyoung
Date: Fri Feb 27 18:18:08 2009
New Revision: 2459
URL: http://svn.gna.org/viewcvs/mysqlpp?rev=2459&view=rev
Log:
Doxygen warning squishers
Modified:
trunk/lib/dbdriver.h
trunk/lib/exceptions.h
trunk/lib/insertpolicy.h
trunk/lib/query.h
trunk/lib/sqlstream.h
Modified: trunk/lib/dbdriver.h
URL:
http://svn.gna.org/viewcvs/mysqlpp/trunk/lib/dbdriver.h?rev=2459&r1=2458&r2=2459&view=diff
==============================================================================
--- trunk/lib/dbdriver.h (original)
+++ trunk/lib/dbdriver.h Fri Feb 27 18:18:08 2009
@@ -180,9 +180,9 @@
/// \brief Return a SQL-escaped version of the given character
/// buffer
///
- /// \param escaped character buffer to hold escaped version; must
+ /// \param to character buffer to hold escaped version; must
/// point to at least (length * 2 + 1) bytes
- /// \param original pointer to the character buffer to escape
+ /// \param from pointer to the character buffer to escape
/// \param length number of characters to escape
///
/// \retval number of characters placed in escaped
Modified: trunk/lib/exceptions.h
URL:
http://svn.gna.org/viewcvs/mysqlpp/trunk/lib/exceptions.h?rev=2459&r1=2458&r2=2459&view=diff
==============================================================================
--- trunk/lib/exceptions.h (original)
+++ trunk/lib/exceptions.h Fri Feb 27 18:18:08 2009
@@ -181,7 +181,7 @@
public:
/// \brief Create exception object
///
- /// \param bad_index type of object bad index tried on
+ /// \param what type of object bad index tried on
/// \param bad_index index value the container didn't like
/// \param max_index largest legal index value for container
explicit BadIndex(const char* what, int bad_index, int max_index) :
Modified: trunk/lib/insertpolicy.h
URL:
http://svn.gna.org/viewcvs/mysqlpp/trunk/lib/insertpolicy.h?rev=2459&r1=2458&r2=2459&view=diff
==============================================================================
--- trunk/lib/insertpolicy.h (original)
+++ trunk/lib/insertpolicy.h Fri Feb 27 18:18:08 2009
@@ -5,7 +5,7 @@
/// collections of SSQLS objects when certain constraints in the raw
/// SQL command, such as a maximum are required.
///
-/// This file is not meant to be #included in end-user code. It's
+/// This file is not meant to be included in end-user code. It's
/// included in Query's public interface, since it is only used with
/// Query::insertfrom(). You access it as Query::InsertPolicy<T>
@@ -71,12 +71,10 @@
{
public:
/// \brief Constructor
- DefaultInsertPolicy() {
- }
+ DefaultInsertPolicy() { }
/// \brief Destructor
- ~DefaultInsertPolicy() {
- }
+ ~DefaultInsertPolicy() { }
/// \brief Can we add another object to the query?
///
@@ -86,10 +84,9 @@
/// \retval true if the object is allowed to be added to the
/// INSERT statement
template <class RowT>
- bool can_add(int size, const RowT& object) const {
- return true;
- }
-
+ bool can_add(int size, const RowT& object) const { return true; }
+
+ /// \brief Alias for our access controller type
typedef AccessController access_controller;
};
@@ -126,7 +123,7 @@
return (size < size_);
}
-
+ /// \brief Alias for our access controller type
typedef AccessController access_controller;
private:
@@ -193,11 +190,11 @@
}
}
+ /// \brief Alias for our access controller type
typedef AccessController access_controller;
private:
Connection* conn_;
-
int size_;
};
Modified: trunk/lib/query.h
URL:
http://svn.gna.org/viewcvs/mysqlpp/trunk/lib/query.h?rev=2459&r1=2458&r2=2459&view=diff
==============================================================================
--- trunk/lib/query.h (original)
+++ trunk/lib/query.h Fri Feb 27 18:18:08 2009
@@ -123,9 +123,11 @@
public OptionalExceptions
{
public:
+#if !defined(DOXYGEN_IGNORE)
// Bring in InsertPolicy template as part of this class's interface,
// separate only in the sense that it's a self-contained concept.
#include "insertpolicy.h"
+#endif
/// \brief Create a new query object attached to a connection.
///
Modified: trunk/lib/sqlstream.h
URL:
http://svn.gna.org/viewcvs/mysqlpp/trunk/lib/sqlstream.h?rev=2459&r1=2458&r2=2459&view=diff
==============================================================================
--- trunk/lib/sqlstream.h (original)
+++ trunk/lib/sqlstream.h Fri Feb 27 18:18:08 2009
@@ -98,6 +98,7 @@
size_t escape_string(char* escaped, const char* original,
size_t length) const;
+ /// \brief Assigns contents of another SQLStream to this one
SQLStream& operator=(const SQLStream& rhs);
/// \brief Connection to send queries through
_______________________________________________
Mysqlpp-commits mailing list
[email protected]
https://mail.gna.org/listinfo/mysqlpp-commits
