User story #103
Updated by Ivan Herrero almost 10 years ago
Implement requirement MARTe-EX-D-1.2.1 based on the original MARTe implementation
Note: One of the key features of MARTe is the possibility of executing real-time multi-threading applications.
h1. Source code files modified
* Source/Core/L0Portability/ThreadsDatabase.h
* Source/Core/L0Portability/ThreadsDatabase.cpp
* Source/Core/L0Portability/Threads.h
* Source/Core/L0Portability/Threads.cpp
* Source/Core/L0Portability/OperatingSystem/Linux/ThreadsOS.h
* Source/Core/L0Portability/OperatingSystem/Windows/ThreadsOS.h
* Source/Core/L0Portability/ThreadInformation.h
* Source/Core/L0Portability/TimeoutType.h
h1. Architecture & design review
*Date of the review:* 08/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 class 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:* 16/06/2015
*Person who did the review:* Ivan Herrero
*Result of review:* FAIL
*List of non-conformities:*
Manual review for Source/Core/L0Portability/ThreadsDatabase.h
Violation of rule "definition for inline functions shall be outside class declaration".
Violation of rule “visibility sections of a class shall appear in the following order (public, protected and private)”.
Lack of @details tag on class details documentation.
Manual review for Source/Core/L0Portability/ThreadsDatabase.cpp
The @brief tag on file documentation says "Header file" instead of "Source file" (fix it copying the final text from last marte_cpp_code_templates.xml version).
The @details tag on file documentation says "header" and "declaration" instead of "source" and "definition" (fix it copying the final text from last marte_cpp_code_templates.xml version).
Definition of methods have comments which seem to overlap with those on declaration counterparts.
Manual review for Source/Core/L0Portability/Threads.h
Violation of rule "definition for inline functions shall be outside class declaration".
Put the standalone comment before method SetPriorityLevel as class details or as method details.
Method BeginThread does not have the @details documentation tag in the expected order.
Manual review for Source/Core/L0Portability/Threads.cpp
The @brief tag on file documentation says "Header file" instead of "Source file" (fix it copying the final text from last marte_cpp_code_templates.xml version).
The @details tag on file documentation says "header" and "declaration" instead of "source" and "definition" (fix it copying the final text from last marte_cpp_code_templates.xml version).
The include for "INCLUDE_FILE_OPERATING_SYSTEM(OPERATING_SYSTEM,ThreadsOS.h)" is duplicated.
Manual review for Source/Core/L0Portability/OperatingSystem/Linux/ThreadsOS.h
Relax rule "definition for inline functions shall be outside class declaration"
Methods SetPriorityLevel and IsAlive do not have the @details documentation tag in the expected order.
Method Name does not document the direction of its parameter.
Manual review for Source/Core/L0Portability/OperatingSystem/Windows/ThreadsOS.h
Function ThreadProtectedExecute does not have documentation at all.
Relax rule "definition for inline functions shall be outside class declaration"
Methods SetPriorityLevel and IsAlive do not have the @details documentation tag in the expected order.
Method Name does not document the direction of its parameter.
Manual review for Source/Core/L0Portability/ThreadInformation.h
OK
Manual review for Source/Core/L0Portability/TimeoutType.h
There is a standalone comment before class documentation.
*Note:* Automatic review with cppcheck OK
Note: One of the key features of MARTe is the possibility of executing real-time multi-threading applications.
h1. Source code files modified
* Source/Core/L0Portability/ThreadsDatabase.h
* Source/Core/L0Portability/ThreadsDatabase.cpp
* Source/Core/L0Portability/Threads.h
* Source/Core/L0Portability/Threads.cpp
* Source/Core/L0Portability/OperatingSystem/Linux/ThreadsOS.h
* Source/Core/L0Portability/OperatingSystem/Windows/ThreadsOS.h
* Source/Core/L0Portability/ThreadInformation.h
* Source/Core/L0Portability/TimeoutType.h
h1. Architecture & design review
*Date of the review:* 08/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 class 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:* 16/06/2015
*Person who did the review:* Ivan Herrero
*Result of review:* FAIL
*List of non-conformities:*
Manual review for Source/Core/L0Portability/ThreadsDatabase.h
Violation of rule "definition for inline functions shall be outside class declaration".
Violation of rule “visibility sections of a class shall appear in the following order (public, protected and private)”.
Lack of @details tag on class details documentation.
Manual review for Source/Core/L0Portability/ThreadsDatabase.cpp
The @brief tag on file documentation says "Header file" instead of "Source file" (fix it copying the final text from last marte_cpp_code_templates.xml version).
The @details tag on file documentation says "header" and "declaration" instead of "source" and "definition" (fix it copying the final text from last marte_cpp_code_templates.xml version).
Definition of methods have comments which seem to overlap with those on declaration counterparts.
Manual review for Source/Core/L0Portability/Threads.h
Violation of rule "definition for inline functions shall be outside class declaration".
Put the standalone comment before method SetPriorityLevel as class details or as method details.
Method BeginThread does not have the @details documentation tag in the expected order.
Manual review for Source/Core/L0Portability/Threads.cpp
The @brief tag on file documentation says "Header file" instead of "Source file" (fix it copying the final text from last marte_cpp_code_templates.xml version).
The @details tag on file documentation says "header" and "declaration" instead of "source" and "definition" (fix it copying the final text from last marte_cpp_code_templates.xml version).
The include for "INCLUDE_FILE_OPERATING_SYSTEM(OPERATING_SYSTEM,ThreadsOS.h)" is duplicated.
Manual review for Source/Core/L0Portability/OperatingSystem/Linux/ThreadsOS.h
Relax rule "definition for inline functions shall be outside class declaration"
Methods SetPriorityLevel and IsAlive do not have the @details documentation tag in the expected order.
Method Name does not document the direction of its parameter.
Manual review for Source/Core/L0Portability/OperatingSystem/Windows/ThreadsOS.h
Function ThreadProtectedExecute does not have documentation at all.
Relax rule "definition for inline functions shall be outside class declaration"
Methods SetPriorityLevel and IsAlive do not have the @details documentation tag in the expected order.
Method Name does not document the direction of its parameter.
Manual review for Source/Core/L0Portability/ThreadInformation.h
OK
Manual review for Source/Core/L0Portability/TimeoutType.h
There is a standalone comment before class documentation.
*Note:* Automatic review with cppcheck OK