diff options
author | Mark Spruiell <mes@zeroc.com> | 2018-01-17 15:31:02 -0800 |
---|---|---|
committer | Mark Spruiell <mes@zeroc.com> | 2018-01-17 15:31:02 -0800 |
commit | f1565f0f13b88c1ab04fb66aff67e9ac443af8ac (patch) | |
tree | 63286d397a95213db55a305cf1a48bcebf70047b /cpp/include/Ice/ExceptionHelpers.h | |
parent | More Travis CI fixes (diff) | |
download | ice-f1565f0f13b88c1ab04fb66aff67e9ac443af8ac.tar.bz2 ice-f1565f0f13b88c1ab04fb66aff67e9ac443af8ac.tar.xz ice-f1565f0f13b88c1ab04fb66aff67e9ac443af8ac.zip |
Adding doc comments to C++
Diffstat (limited to 'cpp/include/Ice/ExceptionHelpers.h')
-rw-r--r-- | cpp/include/Ice/ExceptionHelpers.h | 18 |
1 files changed, 18 insertions, 0 deletions
diff --git a/cpp/include/Ice/ExceptionHelpers.h b/cpp/include/Ice/ExceptionHelpers.h index 0865fa0f178..e7e44246459 100644 --- a/cpp/include/Ice/ExceptionHelpers.h +++ b/cpp/include/Ice/ExceptionHelpers.h @@ -20,24 +20,40 @@ namespace Ice class LocalException; +/** + * Helper template for local exceptions. + * \headerfile Ice/Ice.h + */ template<typename T, typename B> class LocalExceptionHelper : public IceUtil::ExceptionHelper<T, B> { public: using IceUtil::ExceptionHelper<T, B>::ExceptionHelper; + /** + * Obtains the Slice type ID of this exception. + * @return The fully-scoped type ID. + */ virtual std::string ice_id() const override { return T::ice_staticId(); } }; +/** + * Helper template for user exceptions. + * \headerfile Ice/Ice.h + */ template<typename T, typename B> class UserExceptionHelper : public IceUtil::ExceptionHelper<T, B> { public: using IceUtil::ExceptionHelper<T, B>::ExceptionHelper; + /** + * Obtains the Slice type ID of this exception. + * @return The fully-scoped type ID. + */ virtual std::string ice_id() const override { return T::ice_staticId(); @@ -45,6 +61,7 @@ public: protected: + /// \cond STREAM virtual void _writeImpl(Ice::OutputStream* os) const override { os->startSlice(T::ice_staticId(), -1, std::is_same<B, Ice::LocalException>::value ? true : false); @@ -60,6 +77,7 @@ protected: is->endSlice(); B::_readImpl(is); } + /// \endcond }; } |