diff options
author | Peter Bozsó | 2016-05-28 20:10:38 +0200 |
---|---|---|
committer | Alexander Tkachev | 2016-08-24 16:07:55 +0600 |
commit | 81c34adaef269524b1f53adcac722aa6a9730075 (patch) | |
tree | da867e32df6a20b06b2e433948e5f94e17ec73f7 /common | |
parent | f4dfaed19d14c309e44d390b44bff571566779a5 (diff) | |
download | scummvm-rg350-81c34adaef269524b1f53adcac722aa6a9730075.tar.gz scummvm-rg350-81c34adaef269524b1f53adcac722aa6a9730075.tar.bz2 scummvm-rg350-81c34adaef269524b1f53adcac722aa6a9730075.zip |
Fix comment formatting
Diffstat (limited to 'common')
-rw-r--r-- | common/callback.h | 128 | ||||
-rw-r--r-- | common/cloudmanager.h | 45 |
2 files changed, 82 insertions, 91 deletions
diff --git a/common/callback.h b/common/callback.h index 4356e4b551..c6c249a511 100644 --- a/common/callback.h +++ b/common/callback.h @@ -26,20 +26,19 @@ namespace Common { /** -* BaseCallback<S> is a simple base class for object-oriented callbacks. -* -* Object-oriented callbacks are such callbacks that know exact instance -* which method must be called. -* -* For backwards compatibility purposes, there is a GlobalFunctionCallback, -* which is BaseCallback<void *>, so it can be used with global C-like -* functions too. -* -* <S> is the type, which is passed to operator() of this callback. -* This allows you to specify that you accept a callback, which wants -* to receive an <S> object. -*/ - + * BaseCallback<S> is a simple base class for object-oriented callbacks. + * + * Object-oriented callbacks are such callbacks that know exact instance + * which method must be called. + * + * For backwards compatibility purposes, there is a GlobalFunctionCallback, + * which is BaseCallback<void *>, so it can be used with global C-like + * functions too. + * + * <S> is the type, which is passed to operator() of this callback. + * This allows you to specify that you accept a callback, which wants + * to receive an <S> object. + */ template<typename S = void *> class BaseCallback { public: BaseCallback() {} @@ -48,13 +47,12 @@ public: }; /** -* GlobalFunctionCallback<T> is a simple wrapper for global C functions. -* -* If there is a method, which accepts BaseCallback<T>, you can -* easily pass your C function by passing -* new GlobalFunctionCallback<T>(yourFunction) -*/ - + * GlobalFunctionCallback<T> is a simple wrapper for global C functions. + * + * If there is a method, which accepts BaseCallback<T>, you can + * easily pass your C function by passing + * new GlobalFunctionCallback<T>(yourFunction) + */ template<typename T> class GlobalFunctionCallback: public BaseCallback<T> { typedef void(*GlobalFunction)(T result); GlobalFunction _callback; @@ -68,20 +66,19 @@ public: }; /** -* Callback<T, S> implements an object-oriented callback. -* -* <T> stands for a class which method you want to call. -* <S>, again, is the type of an object passed to operator(). -* -* So, if you have void MyClass::myMethod(AnotherClass) method, -* the corresponding callback is Callback<MyClass, AnotherClass>. -* You create it similarly to this: -* new Callback<MyClass, AnotherClass>( -* pointerToMyClassObject, -* &MyClass::myMethod -* ) -*/ - + * Callback<T, S> implements an object-oriented callback. + * + * <T> stands for a class which method you want to call. + * <S>, again, is the type of an object passed to operator(). + * + * So, if you have void MyClass::myMethod(AnotherClass) method, + * the corresponding callback is Callback<MyClass, AnotherClass>. + * You create it similarly to this: + * new Callback<MyClass, AnotherClass>( + * pointerToMyClassObject, + * &MyClass::myMethod + * ) + */ template<class T, typename S = void *> class Callback: public BaseCallback<S> { protected: typedef void(T::*TMethod)(S); @@ -94,37 +91,36 @@ public: }; /** -* CallbackBridge<T, OS, S> helps you to chain callbacks. -* -* CallbackBridge keeps a pointer to BaseCallback<OS>. -* When its operator() is called, it passes this pointer -* along with the actual data (of type <S>) to the method -* of <T> class. -* -* This is needed when you have to call a callback only -* when your own callback is called. So, your callback -* is "inner" and the other one is "outer". -* -* CallbackBridge implements the "inner" one and calls -* the method you wanted. It passes the "outer", so you -* can call it from your method. You can ignore it, but -* probably there is no point in using CallbackBridge then. -* -* So, if you receive a BaseCallback<SomeClass> callback -* and you want to call it from your MyClass::myMethod method, -* you should create CallbackBridge<MyClass, SomeClass, S>, -* where <S> is data type you want to receive in MyClass::myMethod. -* -* You create it similarly to this: -* new Callback<MyClass, SomeClass, AnotherClass>( -* pointerToMyClassObject, -* &MyClass::myMethod, -* outerCallback -* ) -* where `outerCallback` is BaseCallback<SomeClass> and `myMethod` is: -* void MyClass::myMethod(BaseCallback<SomeClass> *, AnotherClass) -*/ - + * CallbackBridge<T, OS, S> helps you to chain callbacks. + * + * CallbackBridge keeps a pointer to BaseCallback<OS>. + * When its operator() is called, it passes this pointer + * along with the actual data (of type <S>) to the method + * of <T> class. + * + * This is needed when you have to call a callback only + * when your own callback is called. So, your callback + * is "inner" and the other one is "outer". + * + * CallbackBridge implements the "inner" one and calls + * the method you wanted. It passes the "outer", so you + * can call it from your method. You can ignore it, but + * probably there is no point in using CallbackBridge then. + * + * So, if you receive a BaseCallback<SomeClass> callback + * and you want to call it from your MyClass::myMethod method, + * you should create CallbackBridge<MyClass, SomeClass, S>, + * where <S> is data type you want to receive in MyClass::myMethod. + * + * You create it similarly to this: + * new Callback<MyClass, SomeClass, AnotherClass>( + * pointerToMyClassObject, + * &MyClass::myMethod, + * outerCallback + * ) + * where `outerCallback` is BaseCallback<SomeClass> and `myMethod` is: + * void MyClass::myMethod(BaseCallback<SomeClass> *, AnotherClass) + */ template<class T, typename OS, typename S = void *> class CallbackBridge: public BaseCallback<S> { typedef void(T::*TCallbackMethod)(BaseCallback<OS> *, S); T *_object; diff --git a/common/cloudmanager.h b/common/cloudmanager.h index a480bdf684..350901e35f 100644 --- a/common/cloudmanager.h +++ b/common/cloudmanager.h @@ -33,45 +33,40 @@ public: virtual ~CloudManager() {} /** - * Loads all information from configs and creates current Storage instance. - * - * @note It's called once on startup in scummvm_main(). - */ - + * Loads all information from configs and creates current Storage instance. + * + * @note It's called once on startup in scummvm_main(). + */ virtual void init() = 0; /** - * Saves all information into configuration file. - */ - + * Saves all information into configuration file. + */ virtual void save() = 0; /** - * Adds new Storage into list. - * - * @param storage Cloud::Storage to add. - * @param makeCurrent whether added storage should be the new current storage. - * @param saveConfig whether save() should be called to update configuration file. - */ - + * Adds new Storage into list. + * + * @param storage Cloud::Storage to add. + * @param makeCurrent whether added storage should be the new current storage. + * @param saveConfig whether save() should be called to update configuration file. + */ virtual void addStorage(Cloud::Storage *storage, bool makeCurrent = true, bool saveConfig = true) = 0; /** - * Returns active Storage, which could be used to interact - * with cloud storage. - * - * @return active Cloud::Storage or null, if there is no active Storage. - */ - + * Returns active Storage, which could be used to interact + * with cloud storage. + * + * @return active Cloud::Storage or null, if there is no active Storage. + */ virtual Cloud::Storage *getCurrentStorage() = 0; /** - * Starts saves syncing process in currently active storage if there is any. - */ - + * Starts saves syncing process in currently active storage if there is any. + */ virtual void syncSaves(Cloud::Storage::BoolCallback callback = 0) = 0; }; -} //end of namespace Common +} // End of namespace Common #endif |