update some documentation

djmott · Jul 4, 2016 · 1b66117 · 1b66117
1 parent 0913569
commit 1b66117
Show file tree

Hide file tree

Showing 14 changed files with 1,751 additions and 1,759 deletions.
diff --git a/docs/rpc.md b/docs/rpc.md
diff --git a/include/xtd/debug.hpp b/include/xtd/debug.hpp
@@ -1,7 +1,7 @@
-/** @file
- data conversion utilities
-  @copyright David Mott (c) 2016. Distributed under the Boost Software License Version 1.0. See LICENSE.md or http://boost.org/LICENSE_1_0.txt for details.
-
-*/
-
-#define XTD_ASSERT(_exp, ...) assert(_exp)
+/** @file
+ data conversion utilities
+  @copyright David Mott (c) 2016. Distributed under the Boost Software License Version 1.0. See LICENSE.md or http://boost.org/LICENSE_1_0.txt for details.
+
+*/
+
+#define XTD_ASSERT(_exp, ...) assert(_exp)
diff --git a/include/xtd/exception.hpp b/include/xtd/exception.hpp
@@ -1,103 +1,103 @@
-/** @file
-generic and special purpose exceptions
-@copyright David Mott (c) 2016. Distributed under the Boost Software License Version 1.0. See LICENSE.md or http://boost.org/LICENSE_1_0.txt for details.
-
-*/
-
-#pragma once
-
-#if (XTD_COMPILER_GCC & XTD_COMPILER)
-#define XTD_EXCEPTION_MEMBER_NOEXCEPT noexcept
-#else
-#define XTD_EXCEPTION_MEMBER_NOEXCEPT
-#endif
-
-/**
-@def throw_if(_test, _expression) _throw_if(here(), _test, _expression, #_test)
-
-Simplifies use of exception::_throw_if
-
-@param _test       Expression to test
-@param _expression Expression to evaluate the value of _test
-*/
-#define throw_if(_test, _expression) _throw_if(here(), _test, _expression, #_test)
-
-namespace xtd{
-
-/// Base exception for XTL
-  class exception : public std::exception{
-  public:
-    using _super_t = std::exception;
-
-/** Helper function template to test for an expression and throw an exception
-Throws exception if the test expression returns true. _throw_if methods are present in many XTL exception classes. Typically, the throw_if macro will be used as in exception::throw_if to properly fill parameters
-@tparam _ReturnT The return type of the function and type of the expression to evaluate. Implicitly deduced at compile time.
-@tparam _ExpressionT the type of expression tester that evaluates _ReturnT, normally a lambda.
-@param source The location in source code where called.
-@param ret The return value of _throw_if and parameter to exp used to test for success or failure
-@param expstr String value passed to the exceptions constructor when thrown
-@returns ret if no exception is thrown
-*/
-    template <typename _ReturnT, typename _ExpressionT>
-    inline static _ReturnT _throw_if(const xtd::source_location& source, _ReturnT ret, _ExpressionT exp, const char* expstr){
-      if (exp(ret)){
-        throw exception(source, expstr);
-      }
-      return ret;
-    }
-
-/// Constructors @{
-    exception(const source_location& Source, const std::string& What)
-      : _super_t()
-      , _source(Source)
-      , _what(What){}
-    exception(const exception& src)
-      : _super_t()
-      , _source(src._source)
-      , _what(src._what){}
-    exception(exception&& src)
-      : _super_t()
-      , _source(std::move(src._source))
-      , _what(std::move(src._what)){}
-///}@
-
-///explaination of the exception
-    const char * what() const XTD_EXCEPTION_MEMBER_NOEXCEPT override { return _what.c_str(); }
-
-///location in source that caused the exception
-    virtual const source_location& location() const XTD_EXCEPTION_MEMBER_NOEXCEPT  { return _source; }
-
-  protected:
-    const source_location& _source;
-    std::string _what;
-  };
-
-/// Represents an exception of the kernel or core OS component
-  class os_exception : public xtd::exception{
-  public:
-    template <typename _ReturnT, typename _ExpressionT>
-    inline static _ReturnT _throw_if(const xtd::source_location& source, _ReturnT ret, _ExpressionT exp, const char* expstr){
-      if (exp(ret)){
-        throw exception(source, expstr);
-      }
-      return ret;
-    }
-
-    os_exception(const source_location& Source, const std::string& What) : xtd::exception(Source, What){
-      if (!errno){
-        return;
-      }
-      _what += " : ";
-
-#if (XTD_COMPILER_IS_MSVC)
-      _what.resize(_what.size() + 100);
-      strerror_s(&_what[_what.size() - 100], 100, errno);
-      _what.resize(strlen(_what.c_str()));
-#else
-      _what += strerror(errno);
-#endif
-    }
-    os_exception(const os_exception& ex) : xtd::exception(ex){}
-    os_exception(os_exception&& ex) : xtd::exception(std::move(ex)){}
-  };
-}
+/** @file
+generic and special purpose exceptions
+@copyright David Mott (c) 2016. Distributed under the Boost Software License Version 1.0. See LICENSE.md or http://boost.org/LICENSE_1_0.txt for details.
+
+*/
+
+#pragma once
+
+#if (XTD_COMPILER_GCC & XTD_COMPILER)
+#define XTD_EXCEPTION_MEMBER_NOEXCEPT noexcept
+#else
+#define XTD_EXCEPTION_MEMBER_NOEXCEPT
+#endif
+
+/**
+@def throw_if(_test, _expression) _throw_if(here(), _test, _expression, #_test)
+
+Simplifies use of exception::_throw_if
+
+@param _test       Expression to test
+@param _expression Expression to evaluate the value of _test
+*/
+#define throw_if(_test, _expression) _throw_if(here(), _test, _expression, #_test)
+
+namespace xtd{
+
+/// Base exception for XTL
+  class exception : public std::exception{
+  public:
+    using _super_t = std::exception;
+
+/** Helper function template to test for an expression and throw an exception
+Throws exception if the test expression returns true. _throw_if methods are present in many XTL exception classes. Typically, the throw_if macro will be used as in exception::throw_if to properly fill parameters
+@tparam _ReturnT The return type of the function and type of the expression to evaluate. Implicitly deduced at compile time.
+@tparam _ExpressionT the type of expression tester that evaluates _ReturnT, normally a lambda.
+@param source The location in source code where called.
+@param ret The return value of _throw_if and parameter to exp used to test for success or failure
+@param expstr String value passed to the exceptions constructor when thrown
+@returns ret if no exception is thrown
+*/
+    template <typename _ReturnT, typename _ExpressionT>
+    inline static _ReturnT _throw_if(const xtd::source_location& source, _ReturnT ret, _ExpressionT exp, const char* expstr){
+      if (exp(ret)){
+        throw exception(source, expstr);
+      }
+      return ret;
+    }
+
+/// Constructors @{
+    exception(const source_location& Source, const std::string& What)
+      : _super_t()
+      , _source(Source)
+      , _what(What){}
+    exception(const exception& src)
+      : _super_t()
+      , _source(src._source)
+      , _what(src._what){}
+    exception(exception&& src)
+      : _super_t()
+      , _source(std::move(src._source))
+      , _what(std::move(src._what)){}
+///}@
+
+///explaination of the exception
+    const char * what() const XTD_EXCEPTION_MEMBER_NOEXCEPT override { return _what.c_str(); }
+
+///location in source that caused the exception
+    virtual const source_location& location() const XTD_EXCEPTION_MEMBER_NOEXCEPT  { return _source; }
+
+  protected:
+    const source_location& _source;
+    std::string _what;
+  };
+
+/// Represents an exception of the kernel or core OS component
+  class os_exception : public xtd::exception{
+  public:
+    template <typename _ReturnT, typename _ExpressionT>
+    inline static _ReturnT _throw_if(const xtd::source_location& source, _ReturnT ret, _ExpressionT exp, const char* expstr){
+      if (exp(ret)){
+        throw exception(source, expstr);
+      }
+      return ret;
+    }
+
+    os_exception(const source_location& Source, const std::string& What) : xtd::exception(Source, What){
+      if (!errno){
+        return;
+      }
+      _what += " : ";
+
+#if (XTD_COMPILER_IS_MSVC)
+      _what.resize(_what.size() + 100);
+      strerror_s(&_what[_what.size() - 100], 100, errno);
+      _what.resize(strlen(_what.c_str()));
+#else
+      _what += strerror(errno);
+#endif
+    }
+    os_exception(const os_exception& ex) : xtd::exception(ex){}
+    os_exception(os_exception&& ex) : xtd::exception(std::move(ex)){}
+  };
+}