User story #295
Updated by Ivan Herrero about 9 years ago
Review the MARTe documentation and fix any issues found during the process.
*Branch:* fix_documentation
h1. Source code files modified
* Source/Core/Namespaces.dox
* Source/Core/BareMetal/L0Types/BitBoolean.h
* Source/Core/BareMetal/L0Types/BitRange.h
* Source/Core/BareMetal/L0Types/DoubleInteger.h
* Source/Core/BareMetal/L0Types/Iterator.h
* Source/Core/BareMetal/L0Types/IteratorT.h
* Source/Core/BareMetal/L0Types/LinkedListHolder.h
* Source/Core/BareMetal/L0Types/LinkedListable.h
* Source/Core/BareMetal/L0Types/Matrix.h
* Source/Core/BareMetal/L0Types/SearchFilter.h
* Source/Core/BareMetal/L0Types/SearchFilterT.h
* Source/Core/BareMetal/L0Types/Shift.h
* Source/Core/BareMetal/L0Types/SortFilter.h
* Source/Core/BareMetal/L0Types/SortFilterT.h
* Source/Core/BareMetal/L0Types/TypeCharacteristics.h
* Source/Core/BareMetal/L0Types/Vector.h
* Source/Core/BareMetal/L1Portability/BasicConsole.h
* Source/Core/BareMetal/L1Portability/Endianity.h
* Source/Core/BareMetal/L1Portability/FastPollingMutexSem.h
* Source/Core/BareMetal/L1Portability/HandleI.h
* Source/Core/BareMetal/L1Portability/HeapI.h
* Source/Core/BareMetal/L1Portability/HeapManager.cpp
* Source/Core/BareMetal/L1Portability/LoadableLibrary.h
* Source/Core/BareMetal/L1Portability/TimeStamp.h
* Source/Core/BareMetal/L2Objects/AnyType.h
* Source/Core/BareMetal/L2Objects/ReferenceT.h
* Source/Core/BareMetal/L3Streams/BitSetToInteger.h
* Source/Core/BareMetal/L3Streams/BufferedStreamGenerator.h
* Source/Core/BareMetal/L3Streams/BufferedStreamIOBuffer.h
* Source/Core/BareMetal/L3Streams/DoubleBufferedStream.h
* Source/Core/BareMetal/L3Streams/IOBuffer.h
* Source/Core/BareMetal/L3Streams/SingleBufferedStream.h
* Source/Core/BareMetal/L4Configuration/ParserI.h
* Source/Core/BareMetal/L4Configuration/Token.h
* Source/Core/BareMetal/L4Configuration/TokenInfo.h
* Source/Core/FileSystem/L1Portability/BasicSocket.h
* Source/Core/FileSystem/L1Portability/BasicTCPSocket.h
* Source/Core/FileSystem/L1Portability/BasicUDPSocket.h
* Source/Core/FileSystem/L1Portability/Directory.h
* Source/Core/FileSystem/L1Portability/DirectoryScanner.h
* Source/Core/FileSystem/L1Portability/InternetHost.h
* Source/Core/FileSystem/L1Portability/InternetService.h
* Source/Core/FileSystem/L1Portability/Select.h
* Source/Core/Scheduler/L1Portability/ExceptionHandler.h
h1. Architecture & design review
*Date of the review:* 18/01/2016
*Person who did the review:* Andre' 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:* 03/02/2016 --/--/2016
*Person who did the review:* Ivan Herrero
*Result of review:* PASS
*List of non-conformities:* N/A N/A.
h1. Unit test review
*Date of the review:* 03/02/2016 --/--/2016
*Person who did the review:* Ivan Herrero -----
*Result of coverage tests review:* PASS [PASS/FAIL]
*Result of functional tests review:* PASS [PASS/FAIL]
*Result of review:* PASS [PASS/FAIL]
*List of non-conformities:* N/A
*Branch:* fix_documentation
h1. Source code files modified
* Source/Core/Namespaces.dox
* Source/Core/BareMetal/L0Types/BitBoolean.h
* Source/Core/BareMetal/L0Types/BitRange.h
* Source/Core/BareMetal/L0Types/DoubleInteger.h
* Source/Core/BareMetal/L0Types/Iterator.h
* Source/Core/BareMetal/L0Types/IteratorT.h
* Source/Core/BareMetal/L0Types/LinkedListHolder.h
* Source/Core/BareMetal/L0Types/LinkedListable.h
* Source/Core/BareMetal/L0Types/Matrix.h
* Source/Core/BareMetal/L0Types/SearchFilter.h
* Source/Core/BareMetal/L0Types/SearchFilterT.h
* Source/Core/BareMetal/L0Types/Shift.h
* Source/Core/BareMetal/L0Types/SortFilter.h
* Source/Core/BareMetal/L0Types/SortFilterT.h
* Source/Core/BareMetal/L0Types/TypeCharacteristics.h
* Source/Core/BareMetal/L0Types/Vector.h
* Source/Core/BareMetal/L1Portability/BasicConsole.h
* Source/Core/BareMetal/L1Portability/Endianity.h
* Source/Core/BareMetal/L1Portability/FastPollingMutexSem.h
* Source/Core/BareMetal/L1Portability/HandleI.h
* Source/Core/BareMetal/L1Portability/HeapI.h
* Source/Core/BareMetal/L1Portability/HeapManager.cpp
* Source/Core/BareMetal/L1Portability/LoadableLibrary.h
* Source/Core/BareMetal/L1Portability/TimeStamp.h
* Source/Core/BareMetal/L2Objects/AnyType.h
* Source/Core/BareMetal/L2Objects/ReferenceT.h
* Source/Core/BareMetal/L3Streams/BitSetToInteger.h
* Source/Core/BareMetal/L3Streams/BufferedStreamGenerator.h
* Source/Core/BareMetal/L3Streams/BufferedStreamIOBuffer.h
* Source/Core/BareMetal/L3Streams/DoubleBufferedStream.h
* Source/Core/BareMetal/L3Streams/IOBuffer.h
* Source/Core/BareMetal/L3Streams/SingleBufferedStream.h
* Source/Core/BareMetal/L4Configuration/ParserI.h
* Source/Core/BareMetal/L4Configuration/Token.h
* Source/Core/BareMetal/L4Configuration/TokenInfo.h
* Source/Core/FileSystem/L1Portability/BasicSocket.h
* Source/Core/FileSystem/L1Portability/BasicTCPSocket.h
* Source/Core/FileSystem/L1Portability/BasicUDPSocket.h
* Source/Core/FileSystem/L1Portability/Directory.h
* Source/Core/FileSystem/L1Portability/DirectoryScanner.h
* Source/Core/FileSystem/L1Portability/InternetHost.h
* Source/Core/FileSystem/L1Portability/InternetService.h
* Source/Core/FileSystem/L1Portability/Select.h
* Source/Core/Scheduler/L1Portability/ExceptionHandler.h
h1. Architecture & design review
*Date of the review:* 18/01/2016
*Person who did the review:* Andre' 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:* 03/02/2016 --/--/2016
*Person who did the review:* Ivan Herrero
*Result of review:* PASS
*List of non-conformities:* N/A N/A.
h1. Unit test review
*Date of the review:* 03/02/2016 --/--/2016
*Person who did the review:* Ivan Herrero -----
*Result of coverage tests review:* PASS [PASS/FAIL]
*Result of functional tests review:* PASS [PASS/FAIL]
*Result of review:* PASS [PASS/FAIL]
*List of non-conformities:* N/A