libt2n: (gerd) improve docu, cleanup for public release

[libt2n] / src / t2n_exception.hxx

diff --git a/src/t2n_exception.hxx b/src/t2n_exception.hxx
index 14243fc..121d482 100644 (file)
--- a/src/t2n_exception.hxx
+++ b/src/t2n_exception.hxx
@@ -38,7 +38,10 @@ void serialize(Archive & ar, std::exception & g, const unsigned int version)
 
 namespace libt2n
 {
-/// a generic exception that can be handeled with libt2n
+/** @brief a generic exception that can be handeled with libt2n
+    @note don't derive the exceptions your application generates directly from this one
+          but use libt2n::t2n_runtime_error for this
+*/
 class t2n_exception : public std::exception
 {
     private:
@@ -232,7 +235,7 @@ class t2n_serialization_error : public t2n_exception
 /** @brief a runtime error within the remote function.
  derive your own custom exceptions from this one
 
- @note you must override the virtual clone method if you do (used by \ref command_server::handle_packet)
+ @note you must override the virtual clone method if you do so (used by libt2n::command_server::handle())
 */
 class t2n_runtime_error : public t2n_exception
 {