atria-soft/esignal
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

[DOC] Finish documentation

Browse Source
This commit is contained in:
Edouard DUPIN 2016-04-07 21:07:11 +02:00
parent 83d77a1ba9
commit 0ff8ca484a
6 changed files with 49 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
.travis.yml
View File

@ -63,14 +63,14 @@ before_script:
- ./ci/build_send.py --tag=$TAG --status=START;
script:
- lutin -w -j4 -C -P -t$TARGET -c $BUILDER $COMPILATOR_OPTION $BUS -m $CONF $GCOV $DISABLE_PACKAGE esignal-test; STATUS=$?
- lutin -w -j4 -C -P -t$TARGET -c $BUILDER $COMPILATOR_OPTION $BUS -m $CONF $GCOV $DISABLE_PACKAGE esignal-*; STATUS=$?
- ./ci/build_send.py --tag=$TAG --status="$STATUS";
after_script:
- if [ "$GCOV" != "" ]; then
./ci/warning_send.py --find-path ./out/Linux_x86_64/$CONF/build/$BUILDER/esignal/;
fi
- ./out/Linux_x86_64/$CONF/staging/$BUILDER/esignal-test/esignal-test.app/bin/esignal-test --etk-log-level=3 | tee out_test.txt
- lutin -w -j4 -C -P -t$TARGET -c $BUILDER $COMPILATOR_OPTION $BUS -m $CONF $GCOV $DISABLE_PACKAGE esignal-test?run:--elog-level=3 | tee out_test.txt
- if [ "$GCOV" != "" ]; then
./ci/test_send.py --file=out_test.txt;
lutin -C -P -t $TARGET -c $BUILDER $COMPILATOR_OPTION $BUS -m $CONF -p esignal?gcov;

2
esignal/Base.h
View File

@ -68,7 +68,7 @@ namespace esignal {
*/
virtual const std::string& getDescription() const;
};
//! @not_in_doc
//! @not-in-doc
std::ostream& operator <<(std::ostream& _os, const esignal::Base& _obj);
#ifdef DEBUG
const char* logIndent(int32_t _iii);

1
esignal/Connection.h
View File

@ -49,6 +49,7 @@ namespace esignal {
Connection(const Connection&) = delete;
/**
* @brief Copy operator (REMOVED)
* @return Reference on this
*/
Connection& operator=(const Connection&) = delete;
/**

5
esignal/LockSharedPtrRef.h
View File

@ -35,7 +35,7 @@ namespace esignal {
LockSharedPtrRef(const LockSharedPtrRef<TYPE>& _obj);
/**
* @brief Copy operator (It copy the counter and increment the it).
* @param[in] _obj objetc to copy.
* @param[in] _obj object to copy.
* @return Reference of this
*/
LockSharedPtrRef& operator=(const LockSharedPtrRef<TYPE>& _obj);
@ -46,8 +46,9 @@ namespace esignal {
LockSharedPtrRef(LockSharedPtrRef<TYPE>&& _obj);
/**
* @brief Copy operator (force move) ==> removed
* @return Reference of this
*/
LockSharedPtrRef& operator=(LockSharedPtrRef<TYPE>&& _obj) = delete;
LockSharedPtrRef& operator=(LockSharedPtrRef<TYPE>&&) = delete;
/**
* @brief Destructor of the class (decrement the counter and remove it if it is the last one...)
*/

36
esignal/RefCount.h
View File

@ -28,14 +28,23 @@ namespace esignal {
RefCount(TYPE* _data);
//! @brief Copy constructor (REMOVED)
RefCount(const RefCount&) = delete;
//! @brief Copy operator (REMOVED)
/**
* @brief Copy operator (REMOVED)
* @return Reference on this
*/
RefCount& operator=(RefCount) = delete;
//! @previous
RefCount& operator=(const RefCount& _obj) = delete;
/**
* @brief Copy operator (REMOVED)
* @return Reference on this
*/
RefCount& operator=(const RefCount&) = delete;
//! @brief Move constructor (REMOVED)
RefCount(RefCount&& _obj) = delete;
//! @brief Move operator (REMOVED)
RefCount& operator=(RefCount&& _obj) = delete;
RefCount(RefCount&&) = delete;
/**
* @brief Move operator (REMOVED)
* @return Reference on this
*/
RefCount& operator=(RefCount&&) = delete;
//! @brief Destructor
~RefCount();
public:
@ -45,13 +54,22 @@ namespace esignal {
void unlock();
//! @brief Increment the ref-counting
void inc();
//! @brief Decrement the ref-counting
/**
* @brief Decrement the ref-counting
* @return Number of element connected when decrement
*/
int64_t dec();
//! @brief Get number of connected
/**
* @brief Get number of connected
* @return The number of element connected on it
*/
int64_t getCount() const;
//! @brief Remove the data
void remove();
//! @brief Get the recoreded data
/**
* @brief Get the recoreded data
* @return The pointer of the data
*/
TYPE* get();
};
}

20
esignal/Signal.h
View File

@ -45,13 +45,23 @@ namespace esignal {
Signal(CLASS_TYPE* _class, FUNC_TYPE _func);
//! @brief Copy constructor (REMOVED)
Signal(const Signal&) = delete;
//! @brief Copy operator (REMOVED)
/**
* @brief Copy operator (REMOVED)
* @return Reference on this
*/
Signal& operator=(Signal) = delete;
Signal& operator=(const Signal& _obj) = delete;
/**
* @brief Copy operator (REMOVED)
* @return Reference on this
*/
Signal& operator=(const Signal&) = delete;
//! @brief Move constructor (REMOVED)
Signal(Signal&& _obj) = delete;
//! @brief Move operator
Signal& operator=(Signal&& _obj) = delete;
Signal(Signal&&) = delete;
/**
* @brief Move operator (REMOVED)
* @return Reference on this
*/
Signal& operator=(Signal&&) = delete;
private:
/**
* @brief Executor: Class to manage the UID and basic value of an observer