Author: mysqlpp
Date: Mon Dec 3 09:41:27 2007
New Revision: 1951
URL: http://svn.gna.org/viewcvs/mysqlpp?rev=1951&view=rev
Log:
Doxygen comment fixes
Modified:
trunk/lib/connection.cpp
trunk/lib/connection.h
trunk/lib/mystring.cpp
trunk/lib/mystring.h
trunk/lib/optionlist.cpp
trunk/lib/optionlist.h
Modified: trunk/lib/connection.cpp
URL:
http://svn.gna.org/viewcvs/mysqlpp/trunk/lib/connection.cpp?rev=1951&r1=1950&r2=1951&view=diff
==============================================================================
--- trunk/lib/connection.cpp (original)
+++ trunk/lib/connection.cpp Mon Dec 3 09:41:27 2007
@@ -43,8 +43,8 @@
}
-Connection::Connection(cchar* db, cchar* server, cchar* user,
- cchar* password, unsigned int port) :
+Connection::Connection(const char* db, const char* server,
+ const char* user, const char* password, unsigned int port) :
OptionalExceptions(),
driver_(new DBDriver()),
copacetic_(true)
@@ -85,8 +85,8 @@
bool
-Connection::connect(cchar* db, cchar* server, cchar* user,
- cchar* password, unsigned int port)
+Connection::connect(const char* db, const char* server,
+ const char* user, const char* password, unsigned int port)
{
// Figure out what the server parameter means, then try to establish
// the connection.
Modified: trunk/lib/connection.h
URL:
http://svn.gna.org/viewcvs/mysqlpp/trunk/lib/connection.h?rev=1951&r1=1950&r2=1951&view=diff
==============================================================================
--- trunk/lib/connection.h (original)
+++ trunk/lib/connection.h Mon Dec 3 09:41:27 2007
@@ -274,7 +274,7 @@
/// \brief Sets a connection option
///
- /// \param option pointer to any derivative of Option allocated on
+ /// \param o pointer to any derivative of Option allocated on
/// the heap
///
/// Objects passed to this method will be released when this
Modified: trunk/lib/mystring.cpp
URL:
http://svn.gna.org/viewcvs/mysqlpp/trunk/lib/mystring.cpp?rev=1951&r1=1950&r2=1951&view=diff
==============================================================================
--- trunk/lib/mystring.cpp (original)
+++ trunk/lib/mystring.cpp Mon Dec 3 09:41:27 2007
@@ -97,6 +97,11 @@
}
}
+
+#if !defined(DOXYGEN_IGNORE)
+// Doxygen isn't smart enough to recognize these template
+// specializations. Maybe it's the MYSQLPP_EXPORT tags?
+
template <>
String
String::conv(String dummy) const { return *this; }
@@ -121,6 +126,8 @@
template <>
Time
String::conv(Time dummy) const { return Time(c_str()); }
+
+#endif // !defined(DOXYGEN_IGNORE)
const char*
Modified: trunk/lib/mystring.h
URL:
http://svn.gna.org/viewcvs/mysqlpp/trunk/lib/mystring.h?rev=1951&r1=1950&r2=1951&view=diff
==============================================================================
--- trunk/lib/mystring.h (original)
+++ trunk/lib/mystring.h Mon Dec 3 09:41:27 2007
@@ -649,6 +649,10 @@
}
+#if !defined(DOXYGEN_IGNORE)
+// Doxygen isn't smart enough to recognize these template
+// specializations. Maybe it's the MYSQLPP_EXPORT tags?
+
/// \brief Specialization of String::conv<Type>() for String
///
/// Yes, I hear you crying, "WTF!? Why does String need to be able to
@@ -687,6 +691,8 @@
/// of the C++ type conversion system anyway.
template <> MYSQLPP_EXPORT Time String::conv(Time) const;
+#endif // !defined(DOXYGEN_IGNORE)
+
} // end namespace mysqlpp
#endif // !defined(MYSQLPP_MYSTRING_H)
Modified: trunk/lib/optionlist.cpp
URL:
http://svn.gna.org/viewcvs/mysqlpp/trunk/lib/optionlist.cpp?rev=1951&r1=1950&r2=1951&view=diff
==============================================================================
--- trunk/lib/optionlist.cpp (original)
+++ trunk/lib/optionlist.cpp Mon Dec 3 09:41:27 2007
@@ -32,6 +32,12 @@
namespace mysqlpp {
+#if !defined(DOXYGEN_IGNORE)
+// We're hiding all the Option subclass internals from Doxygen. All the
+// upper-level classes are documented fully, and each leaf class itself
+// is documented. It's just the ctors and set() methods we're refusing
+// to document over and over again.
+
Option::Error
CompressOption::set(DBDriver* dbd)
{
@@ -334,5 +340,6 @@
#endif
}
+#endif // !defined(DOXYGEN_IGNORE)
} // end namespace mysqlpp
Modified: trunk/lib/optionlist.h
URL:
http://svn.gna.org/viewcvs/mysqlpp/trunk/lib/optionlist.h?rev=1951&r1=1950&r2=1951&view=diff
==============================================================================
--- trunk/lib/optionlist.h (original)
+++ trunk/lib/optionlist.h Mon Dec 3 09:41:27 2007
@@ -63,7 +63,7 @@
err_connected
};
- virtual ~Option() { } ///<
Destroy object
+ virtual ~Option() { } ///< Destroy
object
virtual Error set(DBDriver* dbd) = 0; ///< Apply option
};
@@ -74,7 +74,7 @@
class DataOption : public Option
{
public:
- typedef T ArgType;
+ typedef T ArgType; ///<
Alias for template param
protected:
DataOption(const T& arg) : arg_(arg) { }///< Construct object
_______________________________________________
Mysqlpp-commits mailing list
[email protected]
https://mail.gna.org/listinfo/mysqlpp-commits
