User story #116
Updated by Ivan Herrero almost 10 years ago
Implement requirement MARTe-EX-F-1.3.6 based on the original MARTe implementation
Note: It is crucial that framework developers know why the shared resource was unblocked. Usually, when this happens due to a timeout or an error, the shared resource is no longer valid.
h1. Source code files modified
* Source/Core/L0Portability/EventSem.cpp
* Source/Core/L0Portability/EventSem.h
* Source/Core/L0Portability/FastPollingMutexSem.h
* Source/Core/L0Portability/GeneralDefinitions.h
* Source/Core/L0Portability/MutexSem.cpp
* Source/Core/L0Portability/MutexSem.h
* Source/Core/L0Portability/OperatingSystem/Linux/EventSemOS.h
* Source/Core/L0Portability/OperatingSystem/Linux/MutexSemOS.h
* Source/Core/L0Portability/OperatingSystem/Windows/EventSemOS.h
* Source/Core/L0Portability/OperatingSystem/Windows/MutexSemOS.h
h1. Architecture & design review
*Date of the review:* 12/06/2015
*Person who did the review:* André Neto
*Version of architecture & design document:* N/A. As per the original MARTe implementation, this is a support function and does not require formal design in UML.
*Result of review:* N/A
*List of non-conformities:* N/A
h1. Code and documentation review
*Date of the review:* 25/06/2015 18/06/2015
*Person who did the review:* Ivan Herrero
*Result of review:* FAIL
*List of non-conformities:*
* Source/Core/L0Portability/EventSem.cpp
OK
* Source/Core/L0Portability/EventSem.h
The documentation of default constructor and destructor do not have the "/**" and "*/" symbols on their own line.
The header for section "Inline method definitions" is duplicated.
* Source/Core/L0Portability/FastPollingMutexSem.h
OK
* Source/Core/L0Portability/GeneralDefinitions.h
OK
* Source/Core/L0Portability/MutexSem.cpp
OK
* Source/Core/L0Portability/MutexSem.h
OK
* Source/Core/L0Portability/OperatingSystem/Linux/EventSemOS.h
OK
* Source/Core/L0Portability/OperatingSystem/Linux/MutexSemOS.h
The include of TimeoutType.h shall go to "Project header includes" section.
* Source/Core/L0Portability/OperatingSystem/Windows/EventSemOS.h
The method Close uses on its specification aspects of their implementation (i.e. a call to the CloseHandle method).
* Source/Core/L0Portability/OperatingSystem/Windows/MutexSemOS.h
Did you mean @brief instead of @see on methods FastLock and FastUnLock (in any case, these methods lack documentation for its parameters).
Note: It is crucial that framework developers know why the shared resource was unblocked. Usually, when this happens due to a timeout or an error, the shared resource is no longer valid.
h1. Source code files modified
* Source/Core/L0Portability/EventSem.cpp
* Source/Core/L0Portability/EventSem.h
* Source/Core/L0Portability/FastPollingMutexSem.h
* Source/Core/L0Portability/GeneralDefinitions.h
* Source/Core/L0Portability/MutexSem.cpp
* Source/Core/L0Portability/MutexSem.h
* Source/Core/L0Portability/OperatingSystem/Linux/EventSemOS.h
* Source/Core/L0Portability/OperatingSystem/Linux/MutexSemOS.h
* Source/Core/L0Portability/OperatingSystem/Windows/EventSemOS.h
* Source/Core/L0Portability/OperatingSystem/Windows/MutexSemOS.h
h1. Architecture & design review
*Date of the review:* 12/06/2015
*Person who did the review:* André Neto
*Version of architecture & design document:* N/A. As per the original MARTe implementation, this is a support function and does not require formal design in UML.
*Result of review:* N/A
*List of non-conformities:* N/A
h1. Code and documentation review
*Date of the review:* 25/06/2015 18/06/2015
*Person who did the review:* Ivan Herrero
*Result of review:* FAIL
*List of non-conformities:*
* Source/Core/L0Portability/EventSem.cpp
OK
* Source/Core/L0Portability/EventSem.h
The documentation of default constructor and destructor do not have the "/**" and "*/" symbols on their own line.
The header for section "Inline method definitions" is duplicated.
* Source/Core/L0Portability/FastPollingMutexSem.h
OK
* Source/Core/L0Portability/GeneralDefinitions.h
OK
* Source/Core/L0Portability/MutexSem.cpp
OK
* Source/Core/L0Portability/MutexSem.h
OK
* Source/Core/L0Portability/OperatingSystem/Linux/EventSemOS.h
OK
* Source/Core/L0Portability/OperatingSystem/Linux/MutexSemOS.h
The include of TimeoutType.h shall go to "Project header includes" section.
* Source/Core/L0Portability/OperatingSystem/Windows/EventSemOS.h
The method Close uses on its specification aspects of their implementation (i.e. a call to the CloseHandle method).
* Source/Core/L0Portability/OperatingSystem/Windows/MutexSemOS.h
Did you mean @brief instead of @see on methods FastLock and FastUnLock (in any case, these methods lack documentation for its parameters).