Project

General

Profile

User story #295

Review documentation

Added by André Neto about 9 years ago. Updated about 9 years ago.

Status:
Closed
Priority:
Normal
Assignee:
-
Target version:
0.11
Start date:
18.01.2016
Due date:
% Done:

0%

Estimated time:
Git branch (link):
Git merge to develop (link):
SVN commit (link/?p=rev):

Description

Review the MARTe documentation and fix any issues found during the process.

Branch: fix_documentation

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

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

Code and documentation review

Date of the review: 03/02/2016

Person who did the review: Ivan Herrero

Result of review: PASS

List of non-conformities: N/A

Unit test review

Date of the review: 03/02/2016

Person who did the review: Ivan Herrero

Result of coverage tests review: PASS

Result of functional tests review: PASS

Result of review: PASS

List of non-conformities: N/A

Associated revisions

Revision 144f43f0 (diff)
Added by Ivan Herrero about 9 years ago

#295 - Fix issues on namespaces documentation

All changes has been made on the Namespaces.dox file, which centralizes
the documentation for namespaces.

Revision 9ce668de (diff)
Added by Ivan Herrero about 9 years ago

#295 - Improve documentation on header and source files.

Revision 438483e1 (diff)
Added by Ivan Herrero about 9 years ago

#295 - Improve documentation on header and source files (continuation).

Revision 41246479 (diff)
Added by Ivan Herrero about 9 years ago

#295 - Improve documentation on header and source files (continuation
bis).

History

#1 Updated by André Neto about 9 years ago

  • Description updated (diff)
  • Status changed from New to Code: Impl
  • Target version set to 0.11

#2 Updated by Ivan Herrero about 9 years ago

  • Assignee set to Ivan Herrero

#3 Updated by Ivan Herrero about 9 years ago

  • Description updated (diff)

#4 Updated by Ivan Herrero about 9 years ago

  • Description updated (diff)
  • Status changed from Code: Impl to Closed
  • Assignee deleted (Ivan Herrero)

commit 1bd14283b56d5ccb808b79c575115f45143ec641

Merge branch 'fix_documentation' into develop

Conflicts:
Source/Core/BareMetal/L3Streams/BitSetToInteger.h

Also available in: Atom PDF