User story #281

Check documentation

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

Status:

Closed

Priority:

Normal

Assignee:

Target version:

0.10

Start date:

27.11.2015

Due date:

% Done:

Estimated time:

Git branch (link):

Git merge to develop (link):

SVN commit (link/?p=rev):

Description

Check the framework documentation and in particular make sure that doxygen is outputting in the correct/expected format.

The goal of this user story is to create a documentation review of the status of the documentation. Nevertheless, harmless fixes of documentation can be applied as detected.

The documentation review is an excel checklist, expected to be stored on the documentation repository (https://vcis-gitlab.f4e.europa.eu/aneto/MARTe2-doc/blob/master/Reviews/Documentation%20review.xlsx).

Source code files modified¶

Source/Core/BareMetal/L0Types/ErrorType.h
Source/Core/BareMetal/L1Portability/Atomic.h
Source/Core/BareMetal/L1Portability/BasicConsole.h
Source/Core/BareMetal/L1Portability/Endianity.h
Source/Core/BareMetal/L1Portability/ErrorManagement.h
Source/Core/BareMetal/L1Portability/FastMath.h
Source/Core/BareMetal/L1Portability/HeapManager.h
Source/Core/BareMetal/L1Portability/HighResolutionTimer.h
Source/Core/BareMetal/L1Portability/MemoryCheck.h
Source/Core/BareMetal/L1Portability/Sleep.h
Source/Core/BareMetal/L1Portability/StringHelper.h
Source/Core/BareMetal/L2Objects/ReferenceContainerFilter.h
Source/Core/Namespaces.dox
Source/Core/Scheduler/L1Portability/Environment/Generic/ThreadsDatabase_Generic.h
Source/Core/Scheduler/L1Portability/Processor.h
Source/Core/Scheduler/L1Portability/Threads.h

Source/Core/Mainpage.md

Source/Core/BareMetal/L0Types/BasicType.h
Source/Core/BareMetal/L0Types/BitRange.h
Source/Core/BareMetal/L0Types/CompilerTypes.h
Source/Core/BareMetal/L0Types/DoubleInteger.h
Source/Core/BareMetal/L0Types/FlagsType.h
Source/Core/BareMetal/L0Types/FractionalInteger.h
Source/Core/BareMetal/L0Types/Introspection.h
Source/Core/BareMetal/L0Types/Iterator.h
Source/Core/BareMetal/L0Types/IteratorT.h
Source/Core/BareMetal/L0Types/LinkedListHolder.cpp
Source/Core/BareMetal/L0Types/LinkedListHolder.h
Source/Core/BareMetal/L0Types/LinkedListable.cpp
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/SortFilter.h
Source/Core/BareMetal/L0Types/SortFilterT.h
Source/Core/BareMetal/L0Types/TemplateParametersVerificator.h
Source/Core/BareMetal/L0Types/TypeDescriptor.h
Source/Core/BareMetal/L0Types/Vector.h
Source/Core/BareMetal/L1Portability/Atomic.h
Source/Core/BareMetal/L1Portability/Endianity.h
Source/Core/BareMetal/L1Portability/ErrorInformation.h
Source/Core/BareMetal/L1Portability/ErrorManagement.h
Source/Core/BareMetal/L1Portability/FastMath.h
Source/Core/BareMetal/L1Portability/FastPollingMutexSem.h
Source/Core/BareMetal/L1Portability/FormatDescriptor.h
Source/Core/BareMetal/L1Portability/GeneralDefinitions.h
Source/Core/BareMetal/L1Portability/GlobalObjectI.h
Source/Core/BareMetal/L1Portability/GlobalObjectsDatabase.h
Source/Core/BareMetal/L1Portability/HeapI.h
Source/Core/BareMetal/L1Portability/HeapManager.h
Source/Core/BareMetal/L1Portability/HighResolutionTimer.h
Source/Core/BareMetal/L1Portability/LoadableLibrary.h
Source/Core/BareMetal/L1Portability/MemoryCheck.h
Source/Core/BareMetal/L1Portability/MemoryOperationsHelper.h
Source/Core/BareMetal/L1Portability/ProcessorType.h
Source/Core/BareMetal/L1Portability/Sleep.h
Source/Core/BareMetal/L1Portability/StaticList.h
Source/Core/BareMetal/L1Portability/StaticListHolder.h
Source/Core/BareMetal/L1Portability/StreamI.h
Source/Core/BareMetal/L1Portability/StringHelper.h
Source/Core/BareMetal/L1Portability/TimeoutType.h
Source/Core/BareMetal/L2Objects/AnyType.h
Source/Core/BareMetal/L2Objects/ClassRegistryDatabase.h
Source/Core/BareMetal/L2Objects/ClassRegistryItem.h
Source/Core/BareMetal/L2Objects/Object.h
Source/Core/BareMetal/L2Objects/Reference.h
Source/Core/BareMetal/L2Objects/ReferenceContainer.h
Source/Core/BareMetal/L2Objects/ReferenceContainerFilter.h
Source/Core/BareMetal/L2Objects/ReferenceContainerFilterReferences.h
Source/Core/BareMetal/L2Objects/ReferenceContainerNode.h
Source/Core/BareMetal/L2Objects/ReferenceT.h
Source/Core/BareMetal/L2Objects/StructuredDataI.h
Source/Core/BareMetal/L3Streams/BufferedStreamGenerator.h
Source/Core/BareMetal/L3Streams/BufferedStreamI.h
Source/Core/BareMetal/L3Streams/BufferedStreamIOBuffer.h
Source/Core/BareMetal/L3Streams/DoubleBufferedStream.h
Source/Core/BareMetal/L3Streams/OperatingSystemCallbacksI.h
Source/Core/BareMetal/L3Streams/SingleBufferedStream.h
Source/Core/BareMetal/L3Streams/StreamMemoryReference.h
Source/Core/BareMetal/L3Streams/StreamString.h
Source/Core/BareMetal/L3Streams/StreamStringIOBuffer.h
Source/Core/BareMetal/L4Configuration/AnyObject.h
Source/Core/BareMetal/L4Configuration/Parser.h
Source/Core/BareMetal/L4Configuration/ParserGrammar.h
Source/Core/BareMetal/L4Configuration/TypeConversion.h
Source/Core/FileSystem/L1Portability/BasicSocket.h
Source/Core/FileSystem/L1Portability/BasicTCPSocket.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/FileSystem/L1Portability/SocketSelect.h
Source/Core/Scheduler/L1Portability/EventSem.h
Source/Core/Scheduler/L1Portability/MutexSem.h
Source/Core/Scheduler/L1Portability/Processor.h
Source/Core/Scheduler/L1Portability/SemCore.h
Source/Core/Scheduler/L1Portability/ThreadInformation.h
Source/Core/Scheduler/L1Portability/Threads.h

Source/Core/BareMetal/L0Types/Shift.h
Source/Core/BareMetal/L1Portability/TimeoutType.h
Source/Core/BareMetal/L3Streams/BufferedStreamGenerator.h
Source/Core/BareMetal/L3Streams/BufferedStreamIOBuffer.h
Source/Core/BareMetal/L3Streams/IOBuffer.h
Source/Core/BareMetal/L3Streams/StreamStringIOBuffer.h
Source/Core/FileSystem/L1Portability/BasicFile.h

Associated revisions

Revision 173ee29c (diff)
Added by Ivan Herrero over 9 years ago

#281 - Refactor namespaces documentation

All namespaces documentation scattered across several header files, now
have been centralized on the Namespaces.dox file.

Revision 727ae7db (diff)
Added by Ivan Herrero over 9 years ago

#281 - Add a draft main page to be written with markdown syntax.

Revision 1a63f4c3 (diff)
Added by Ivan Herrero over 9 years ago

#281 - Apply autoformatting and fix diacritics in surnames, dates, and
authors.

Note: The autoformat on some files looks awkward.

Revision f0418af0 (diff)
Added by Ivan Herrero over 9 years ago

#281 - Fix minor issues with doxygen tags.

History

#1 Updated by André Neto over 9 years ago

Target version changed from 0.9 to 0.10

#2 Updated by Giuseppe Ferro over 9 years ago

Assignee set to Ivan Herrero

#3 Updated by Ivan Herrero over 9 years ago

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

The branch #281_Check_documentation contains the commits with the documentation fixes applied to source code files. Its merge with develop should be straightforward, because the modifications have been made mainly in the headers of files and class declarations.

The branch master on documentation repository contains the new doxygen configuration file and the review (https://vcis-gitlab.f4e.europa.eu/aneto/MARTe2-doc/blob/master/Reviews/Documentation%20review.xlsx).

#4 Updated by André Neto over 9 years ago

Merged with develop in commit d00c9e5aa1c2db4dbd21df6db691ae3f91004af1.

#5 Updated by André Neto over 9 years ago

Status changed from Code: Rev to Closed

Also available in: Atom PDF

Project

General

Profile

MARTe2 » MARTe2-core

Issues

Custom queries