From 3501e25a5c731ce28610a9ca8fbd33c55274c053 Mon Sep 17 00:00:00 2001 From: Avi Date: Fri, 17 Sep 2021 19:54:06 +0200 Subject: [PATCH] Fix minor typos in code comments/messages etc. --- Autocoders/MagicDrawCompPlugin/Doxyfile | 6 +++--- .../doc/html/search/search.js | 2 +- ..._1_1componentaction_1_1_i_s_f_component.tex | 4 ++-- ..._1_1componentaction_1_1_i_s_f_subsystem.tex | 2 +- ...n_1_1_i_s_f_subsystem_1_1topology_model.tex | 2 +- ...mponentaction_1_1_process_i_s_f_project.tex | 2 +- ...ponentaction_1_1_process_i_s_f_topology.tex | 10 +++++----- .../MagicDrawCompPlugin/doc/latex/index.tex | 2 +- ...omponentaction_ISFSubsystem_topologyModel.3 | 2 +- ...asa_jpl_componentaction_ProcessISFProject.3 | 2 +- ...sa_jpl_componentaction_ProcessISFTopology.3 | 10 +++++----- .../doc/xml/_process_i_s_f_topology_8java.xml | 2 +- ..._1_1componentaction_1_1_i_s_f_component.xml | 4 ++-- ..._1_1componentaction_1_1_i_s_f_subsystem.xml | 2 +- ...n_1_1_i_s_f_subsystem_1_1topology_model.xml | 2 +- ...mponentaction_1_1_process_i_s_f_project.xml | 2 +- ...ponentaction_1_1_process_i_s_f_topology.xml | 8 ++++---- .../MagicDrawCompPlugin/doc/xml/indexpage.xml | 2 +- .../nasa/jpl/componentaction/ISFSubsystem.java | 2 +- .../nasa/jpl/componentaction/LoadIDConfig.java | 2 +- .../componentaction/MainMenuConfigurator.java | 2 +- .../jpl/componentaction/ProcessISFProject.java | 2 +- .../componentaction/ProcessISFTopology.java | 18 +++++++++--------- .../Python/schema/default/common_elements.rng | 2 +- .../Python/schema/default/topology_schema.rng | 2 +- .../src/fprime_ac/generators/formatters.py | 12 ++++++------ .../generators/templates/component/hpp.tmpl | 2 +- .../generators/visitors/PortCppVisitor.py | 4 ++-- .../Python/src/fprime_ac/models/Event.py | 2 +- .../Python/src/fprime_ac/models/Serialize.py | 2 +- .../fprime_ac/parsers/XmlComponentParser.py | 2 +- .../src/fprime_ac/parsers/XmlTopologyParser.py | 2 +- .../Python/src/fprime_ac/utils/pyparsing.py | 4 ++-- Autocoders/Python/test/enum/ExampleEnumAi.xml | 2 +- Drv/Ip/SocketReadTask.cpp | 2 +- Drv/Ip/SocketReadTask.hpp | 4 ++-- Drv/Ip/UdpSocket.hpp | 4 ++-- Drv/Ip/test/ut/SocketTestHelper.hpp | 2 +- .../LinuxGpioDriverComponentImpl.cpp | 4 ++-- .../LinuxI2cDriverComponentImpl.cpp | 2 +- .../LinuxI2cDriverComponentImplStub.cpp | 2 +- .../LinuxSerialDriverComponentImpl.cpp | 2 +- Drv/TcpClient/TcpClientComponentImpl.hpp | 6 +++--- Drv/TcpServer/TcpServerComponentImpl.hpp | 6 +++--- Drv/Udp/UdpComponentImpl.hpp | 8 ++++---- Fw/Buffer/Buffer.hpp | 2 +- Fw/Deprecate.hpp | 2 +- Fw/Logger/test/ut/Main.cpp | 2 +- Fw/Obj/ObjBase.hpp | 2 +- Fw/Port/InputSerializePort.cpp | 2 +- Fw/Types/Serializable.hpp | 2 +- Os/Baremetal/Queue.cpp | 2 +- Os/Pthreads/MaxHeap/MaxHeap.hpp | 2 +- Os/SimpleQueueRegistry.hpp | 4 ++-- Svc/ActiveRateGroup/ActiveRateGroupImpl.hpp | 2 +- Svc/ActiveTextLogger/ActiveTextLoggerImpl.cpp | 2 +- Svc/ActiveTextLogger/ActiveTextLoggerImpl.hpp | 2 +- Svc/ActiveTextLogger/LogFile.cpp | 4 ++-- Svc/ActiveTextLogger/LogFile.hpp | 2 +- Svc/ActiveTextLogger/test/ut/Tester.cpp | 2 +- Svc/CmdDispatcher/CommandDispatcherImpl.hpp | 4 ++-- Svc/CmdSequencer/test/ut/Immediate.hpp | 2 +- Svc/CmdSequencer/test/ut/Relative.hpp | 2 +- Svc/FileDownlink/FileDownlink.hpp | 2 +- Svc/FileDownlink/test/ut/Tester.cpp | 2 +- Svc/FileUplink/FileUplink.hpp | 2 +- Svc/Health/HealthComponentImpl.hpp | 2 +- Utils/Hash/HashBuffer.hpp | 2 +- Utils/Hash/libcrc/CRC32.cpp | 6 +++--- Utils/Hash/libcrc/tst_crc.c | 2 +- Utils/Types/CircularBuffer.hpp | 2 +- cmake/support/parser/ai_parser.py | 2 +- cmake/test/src/cmake.py | 2 +- config/FpConfig.hpp | 6 +++--- 74 files changed, 121 insertions(+), 121 deletions(-) diff --git a/Autocoders/MagicDrawCompPlugin/Doxyfile b/Autocoders/MagicDrawCompPlugin/Doxyfile index 32b403ddab..d0467f16ff 100644 --- a/Autocoders/MagicDrawCompPlugin/Doxyfile +++ b/Autocoders/MagicDrawCompPlugin/Doxyfile @@ -18,7 +18,7 @@ #--------------------------------------------------------------------------- # This tag specifies the encoding used for all characters in the config file -# that follow. The default is UTF-8 which is also the encoding used for all text +# that follows. The default is UTF-8 which is also the encoding used for all text # before the first occurrence of this tag. Doxygen uses libiconv (or the iconv # built into libc) for the transcoding. See http://www.gnu.org/software/libiconv # for the list of possible encodings. @@ -174,7 +174,7 @@ STRIP_FROM_PATH = STRIP_FROM_INC_PATH = # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but -# less readable) file names. This can be useful is your file systems doesn't +# less readable) file names. This can be useful if your file systems doesn't # support long names like on DOS, Mac, or CD-ROM. # The default value is: NO. @@ -2216,7 +2216,7 @@ HAVE_DOT = YES DOT_NUM_THREADS = 0 -# When you want a differently looking font in the dot files that doxygen +# When you want a different looking font in the dot files that doxygen # generates you can specify the font name using DOT_FONTNAME. You need to make # sure dot is able to find the font, which can be done by putting it in a # standard location or by setting the DOTFONTPATH environment variable or by diff --git a/Autocoders/MagicDrawCompPlugin/doc/html/search/search.js b/Autocoders/MagicDrawCompPlugin/doc/html/search/search.js index dedce3bf09..d6e17b602d 100644 --- a/Autocoders/MagicDrawCompPlugin/doc/html/search/search.js +++ b/Autocoders/MagicDrawCompPlugin/doc/html/search/search.js @@ -251,7 +251,7 @@ function SearchBox(name, resultsPath, inFrame, label) } } - // Called when an search filter selection is made. + // Called when a search filter selection is made. // set item with index id as the active item this.OnSelectItem = function(id) { diff --git a/Autocoders/MagicDrawCompPlugin/doc/latex/classgov_1_1nasa_1_1jpl_1_1componentaction_1_1_i_s_f_component.tex b/Autocoders/MagicDrawCompPlugin/doc/latex/classgov_1_1nasa_1_1jpl_1_1componentaction_1_1_i_s_f_component.tex index a49c88ee05..82c07921c7 100644 --- a/Autocoders/MagicDrawCompPlugin/doc/latex/classgov_1_1nasa_1_1jpl_1_1componentaction_1_1_i_s_f_component.tex +++ b/Autocoders/MagicDrawCompPlugin/doc/latex/classgov_1_1nasa_1_1jpl_1_1componentaction_1_1_i_s_f_component.tex @@ -667,7 +667,7 @@ \subsection{Member Function Documentation} \item[{Element}]{port\+Element} \end{DoxyParamCaption} ) throws {\bf Port\+Exception}}\label{classgov_1_1nasa_1_1jpl_1_1componentaction_1_1_i_s_f_component_a092093642fbaab5c3cf710bef9af6e62} -Creates a new port object using the port Element inputed. This processes the port and can throw an exception if something in the port is illegal. It also adds the port into fill\+List. +Creates a new port object using the port Element inputted. This processes the port and can throw an exception if something in the port is illegal. It also adds the port into fill\+List. \begin{DoxyParams}{Parameters} @@ -710,7 +710,7 @@ \subsection{Member Function Documentation} \item[{Element}]{port\+Element} \end{DoxyParamCaption} ) throws {\bf Port\+Exception}}\label{classgov_1_1nasa_1_1jpl_1_1componentaction_1_1_i_s_f_component_a9c0cb98c724eb5022707663242c3460b} -Creates a new port object using the port Element inputed. This processes the port and can throw an exception if something in the port is illegal. It also adds the port into fill\+List. +Creates a new port object using the port Element inputted. This processes the port and can throw an exception if something in the port is illegal. It also adds the port into fill\+List. \begin{DoxyParams}{Parameters} diff --git a/Autocoders/MagicDrawCompPlugin/doc/latex/classgov_1_1nasa_1_1jpl_1_1componentaction_1_1_i_s_f_subsystem.tex b/Autocoders/MagicDrawCompPlugin/doc/latex/classgov_1_1nasa_1_1jpl_1_1componentaction_1_1_i_s_f_subsystem.tex index b4d681e67a..84b14a7acf 100644 --- a/Autocoders/MagicDrawCompPlugin/doc/latex/classgov_1_1nasa_1_1jpl_1_1componentaction_1_1_i_s_f_subsystem.tex +++ b/Autocoders/MagicDrawCompPlugin/doc/latex/classgov_1_1nasa_1_1jpl_1_1componentaction_1_1_i_s_f_subsystem.tex @@ -183,7 +183,7 @@ \subsection{Member Function Documentation} ) throws {\bf Connector\+Exception}\hspace{0.3cm}{\ttfamily [static]}}\label{classgov_1_1nasa_1_1jpl_1_1componentaction_1_1_i_s_f_subsystem_a8d892025f44c008c6afd8c263ce6f458} Both get\+Source\+Conn\+End and get\+Target\+Conn\+End use this function. Incorporates error handling/checking. -The function checks the direction property of the first stereotype found in each port of the connector. Depending on what the connector can see within and around the system, the funcion will return what it sees as the source and what is sees as the target. +The function checks the direction property of the first stereotype found in each port of the connector. Depending on what the connector can see within and around the system, the function will return what it sees as the source and what is sees as the target. \begin{DoxyParams}{Parameters} diff --git a/Autocoders/MagicDrawCompPlugin/doc/latex/classgov_1_1nasa_1_1jpl_1_1componentaction_1_1_i_s_f_subsystem_1_1topology_model.tex b/Autocoders/MagicDrawCompPlugin/doc/latex/classgov_1_1nasa_1_1jpl_1_1componentaction_1_1_i_s_f_subsystem_1_1topology_model.tex index 5ca79a0dda..25faea0f99 100644 --- a/Autocoders/MagicDrawCompPlugin/doc/latex/classgov_1_1nasa_1_1jpl_1_1componentaction_1_1_i_s_f_subsystem_1_1topology_model.tex +++ b/Autocoders/MagicDrawCompPlugin/doc/latex/classgov_1_1nasa_1_1jpl_1_1componentaction_1_1_i_s_f_subsystem_1_1topology_model.tex @@ -41,7 +41,7 @@ \subsection*{Package Attributes} \subsection{Detailed Description} -Used as a object to store the component\+Map, physical\+Connection\+List, name, base\+ID, and instane\+Window. An object of this type is then sent to Isf\+Sub\+Xml\+Writer and is used to write to the X\+ML output file. +Used as an object to store the component\+Map, physical\+Connection\+List, name, base\+ID, and instane\+Window. An object of this type is then sent to Isf\+Sub\+Xml\+Writer and is used to write to the X\+ML output file. \subsection{Constructor \& Destructor Documentation} \index{gov\+::nasa\+::jpl\+::componentaction\+::\+I\+S\+F\+Subsystem\+::topology\+Model@{gov\+::nasa\+::jpl\+::componentaction\+::\+I\+S\+F\+Subsystem\+::topology\+Model}!topology\+Model@{topology\+Model}} diff --git a/Autocoders/MagicDrawCompPlugin/doc/latex/classgov_1_1nasa_1_1jpl_1_1componentaction_1_1_process_i_s_f_project.tex b/Autocoders/MagicDrawCompPlugin/doc/latex/classgov_1_1nasa_1_1jpl_1_1componentaction_1_1_process_i_s_f_project.tex index 751a12f9d9..bf688f40bd 100644 --- a/Autocoders/MagicDrawCompPlugin/doc/latex/classgov_1_1nasa_1_1jpl_1_1componentaction_1_1_process_i_s_f_project.tex +++ b/Autocoders/MagicDrawCompPlugin/doc/latex/classgov_1_1nasa_1_1jpl_1_1componentaction_1_1_process_i_s_f_project.tex @@ -225,7 +225,7 @@ \subsection{Member Function Documentation} \item[{String}]{stereotype} \end{DoxyParamCaption} ) throws {\bf Port\+Exception}\hspace{0.3cm}{\ttfamily [static]}, {\ttfamily [private]}}\label{classgov_1_1nasa_1_1jpl_1_1componentaction_1_1_process_i_s_f_project_a646ef44b66121fc607edccde28725b46} -Creates \doxyref{I\+S\+F\+Component}{p.}{classgov_1_1nasa_1_1jpl_1_1componentaction_1_1_i_s_f_component} objects for all components with associated ports and adds them toe the component\+List. +Creates \doxyref{I\+S\+F\+Component}{p.}{classgov_1_1nasa_1_1jpl_1_1componentaction_1_1_i_s_f_component} objects for all components with associated ports and adds them to the component\+List. \begin{DoxyParams}{Parameters} {\em comp\+Element\+List} & \\ \hline diff --git a/Autocoders/MagicDrawCompPlugin/doc/latex/classgov_1_1nasa_1_1jpl_1_1componentaction_1_1_process_i_s_f_topology.tex b/Autocoders/MagicDrawCompPlugin/doc/latex/classgov_1_1nasa_1_1jpl_1_1componentaction_1_1_process_i_s_f_topology.tex index 4961ad62d4..2c15d60fe3 100644 --- a/Autocoders/MagicDrawCompPlugin/doc/latex/classgov_1_1nasa_1_1jpl_1_1componentaction_1_1_process_i_s_f_topology.tex +++ b/Autocoders/MagicDrawCompPlugin/doc/latex/classgov_1_1nasa_1_1jpl_1_1componentaction_1_1_process_i_s_f_topology.tex @@ -85,7 +85,7 @@ \subsection{Detailed Description} \item All full connections are found using each port in the source port list as a start point. \item Further connections are found using the map of port ends with their associated connectors. \item Some connectors are ignored depending on the multiplicity of the previous source port. This multiplicity is recalculated for every connector. -\item When reached a port that is not owned by a subsystem, the type is checked. If the source port and the target port type do not matched, that target port is ignored. +\item When reached a port that is not owned by a subsystem, the type is checked. If the source port and the target port type do not match, that target port is ignored. \item This process goes on for each source port until either the target port is found, all the associated connectors have been done being searched, or a time out variable is reached. \item Each source and derived target connector ends are processed through the \doxyref{I\+S\+F\+Subsystem}{p.}{classgov_1_1nasa_1_1jpl_1_1componentaction_1_1_i_s_f_subsystem} physical\+Connection\+Type and added to a list. \end{DoxyItemize} @@ -172,7 +172,7 @@ \subsection{Member Function Documentation} For each source port, the program traces down it\textquotesingle{}s path by accessing the subsystem\+Map with the port\textquotesingle{}s ID. All connections associated with the port are put onto a list, the multiplicity is reevaluated, and the program moves onto processing the next port on the list. Every time a new connector is accessed, the target is checked to see if is a leaf target with the same type as the source. If it is, an \doxyref{I\+S\+F\+Subsystem}{p.}{classgov_1_1nasa_1_1jpl_1_1componentaction_1_1_i_s_f_subsystem} physically\+Connection\+Type object is put onto a list. -Additionally, to support multiple instances of ibds, is a a source instance and target instance name is created along side every connection. This name is the the root modules name followed by each subsystem which the connection\textquotesingle{}s path goes through. This name is used if the program detect that target or source subsystem is used more than once. +Additionally, to support multiple instances of ibds, is a source instance and target instance name is created along side every connection. This name is the root modules name followed by each subsystem which the connection\textquotesingle{}s path goes through. This name is used if the program detects that target or source subsystem is used more than once. Exceptions are thrown in the instances where \begin{DoxyItemize} @@ -276,9 +276,9 @@ \subsection{Member Function Documentation} This function serves two purposes. The first is to convert the physical\+Connection\+Set to a physical\+Conneciton\+List. The second is to perform index checking and correction on ports of the cmd\+Reg/cmd or com/cmd\+Response type. -The index checking/correction is done so multiplicites do not need to be specified for cmd/cmd\+Reg or com/cmd\+Response (with port names of seq\+Cmd\+Status and seq\+Cmd\+Buff) blocks. The latter pair has the additinal port name constraint because there are multiple other ports with the same cmd\+Response type. Some of these port are not to be auto-\/indexed. This makes it easier for the user to add and remove these ports without needing to worry about if the indexes of the pairings match. +The index checking/correction is done so multiplicites do not need to be specified for cmd/cmd\+Reg or com/cmd\+Response (with port names of seq\+Cmd\+Status and seq\+Cmd\+Buff) blocks. The latter pair has the additinal port name constraint because there are multiple other ports with the same cmd\+Response type. Some of these ports are not to be auto-\/indexed. This makes it easier for the user to add and remove these ports without needing to worry about if the indexes of the pairings match. -The program redefines the indexes in numerical order. Even if initial indexes are given, for the origin of Cmd and the target of Cmd\+Reg, they are overwritten. They target index of Cmd is preserved and also is written to the source of Cmd\+Reg. +The program redefines the indexes in numerical order. Even if initial indexes are given, for the origin of Cmd and the target of Cmd\+Reg, they are overwritten. The target index of Cmd is preserved and also is written to the source of Cmd\+Reg. M\+E\+T\+H\+O\+D\+O\+L\+O\+GY \begin{DoxyItemize} @@ -408,7 +408,7 @@ \subsection{Member Function Documentation} If the element type is Subsystem, the element is added to a list to be returned. -If the element is an instance of a subsystem, the subsystem\+Owners map is updated, where each key (name of subsystem) is associated with an list of two string arrays. The first String corresponds to the instance name and the second corresponds to the name of the owner of the subsystem. +If the element is an instance of a subsystem, the subsystem\+Owners map is updated, where each key (name of subsystem) is associated with a list of two string arrays. The first String corresponds to the instance name and the second corresponds to the name of the owner of the subsystem. \begin{DoxyParams}{Parameters} diff --git a/Autocoders/MagicDrawCompPlugin/doc/latex/index.tex b/Autocoders/MagicDrawCompPlugin/doc/latex/index.tex index a4ce0c5991..4c65bc84b5 100644 --- a/Autocoders/MagicDrawCompPlugin/doc/latex/index.tex +++ b/Autocoders/MagicDrawCompPlugin/doc/latex/index.tex @@ -47,7 +47,7 @@ \subsubsection*{Port } \subsubsection*{Topology } \doxyref{Process\+I\+S\+F\+Topology.\+java}{p.}{_process_i_s_f_topology_8java} -\/ This object processes the model to create the topology X\+ML diagrams. It can handle multiple subsystem within subsystems as well and multiple instantiations of subsystems and components. ~\newline - \doxyref{I\+S\+F\+Subsystem.\+java}{p.}{_i_s_f_subsystem_8java} -\/ Contains many helper functions and objects used when process the model for the topology diagram. ~\newline + \doxyref{I\+S\+F\+Subsystem.\+java}{p.}{_i_s_f_subsystem_8java} -\/ Contains many helper functions and objects used when processing the model for the topology diagram. ~\newline \doxyref{Isf\+Sub\+Xml\+Writer.\+java}{p.}{_isf_sub_xml_writer_8java} -\/ Writes the processed model to an X\+ML document.\subsection{Exceptions}\label{index_exceptions} These are the Exception objects of this plugin\+: ~\newline \doxyref{Component\+Exception.\+java}{p.}{_component_exception_8java} -\/ Thrown during component processing. ~\newline diff --git a/Autocoders/MagicDrawCompPlugin/doc/man/man3/gov_nasa_jpl_componentaction_ISFSubsystem_topologyModel.3 b/Autocoders/MagicDrawCompPlugin/doc/man/man3/gov_nasa_jpl_componentaction_ISFSubsystem_topologyModel.3 index 5f3e31a4f2..a82a76202e 100644 --- a/Autocoders/MagicDrawCompPlugin/doc/man/man3/gov_nasa_jpl_componentaction_ISFSubsystem_topologyModel.3 +++ b/Autocoders/MagicDrawCompPlugin/doc/man/man3/gov_nasa_jpl_componentaction_ISFSubsystem_topologyModel.3 @@ -49,7 +49,7 @@ gov.nasa.jpl.componentaction.ISFSubsystem.topologyModel \- .in -1c .SH "Detailed Description" .PP -Used as a object to store the componentMap, physicalConnectionList, name, baseID, and instanceWindow\&. An object of this type is then sent to IsfSubXmlWriter and is used to write to the XML output file\&. +Used as an object to store the componentMap, physicalConnectionList, name, baseID, and instanceWindow\&. An object of this type is then sent to IsfSubXmlWriter and is used to write to the XML output file\&. .SH "Constructor & Destructor Documentation" .PP .SS "gov\&.nasa\&.jpl\&.componentaction\&.ISFSubsystem\&.topologyModel\&.topologyModel (HashMap< String, ISFSubsystem\&.componentType > componentItemsMap, ArrayList< ISFSubsystem\&.physicalConnectionType > physicalConnList)" diff --git a/Autocoders/MagicDrawCompPlugin/doc/man/man3/gov_nasa_jpl_componentaction_ProcessISFProject.3 b/Autocoders/MagicDrawCompPlugin/doc/man/man3/gov_nasa_jpl_componentaction_ProcessISFProject.3 index 3503bd8e9a..c2b13baf7b 100644 --- a/Autocoders/MagicDrawCompPlugin/doc/man/man3/gov_nasa_jpl_componentaction_ProcessISFProject.3 +++ b/Autocoders/MagicDrawCompPlugin/doc/man/man3/gov_nasa_jpl_componentaction_ProcessISFProject.3 @@ -151,7 +151,7 @@ Processes all the ports in the processPackage and generates an XML file to store .PP .SS "static void gov\&.nasa\&.jpl\&.componentaction\&.ProcessISFProject\&.processComponents (List< Element > compElementList, String stereotype) throws \fBPortException\fP\fC [static]\fP, \fC [private]\fP" -Creates \fBISFComponent\fP objects for all components with associated ports and adds them toe the componentList\&. +Creates \fBISFComponent\fP objects for all components with associated ports and adds them to the componentList\&. .PP \fBParameters:\fP .RS 4 diff --git a/Autocoders/MagicDrawCompPlugin/doc/man/man3/gov_nasa_jpl_componentaction_ProcessISFTopology.3 b/Autocoders/MagicDrawCompPlugin/doc/man/man3/gov_nasa_jpl_componentaction_ProcessISFTopology.3 index bfe3252c74..03eccfb253 100644 --- a/Autocoders/MagicDrawCompPlugin/doc/man/man3/gov_nasa_jpl_componentaction_ProcessISFTopology.3 +++ b/Autocoders/MagicDrawCompPlugin/doc/man/man3/gov_nasa_jpl_componentaction_ProcessISFTopology.3 @@ -120,7 +120,7 @@ Further connections are found using the map of port ends with their associated c .IP " \(bu" 4 Some connectors are ignored depending on the multiplicity of the previous source port\&. This multiplicity is recalculated for every connector\&. .IP " \(bu" 4 -When reached a port that is not owned by a subsystem, the type is checked\&. If the source port and the target port type do not matched, that target port is ignored\&. +When reached a port that is not owned by a subsystem, the type is checked\&. If the source port and the target port type do not match, that target port is ignored\&. .IP " \(bu" 4 This process goes on for each source port until either the target port is found, all the associated connectors have been done being searched, or a time out variable is reached\&. .IP " \(bu" 4 @@ -176,7 +176,7 @@ Iterates through the list of source ports and tries to find the final destinatio .PP For each source port, the program traces down it's path by accessing the subsystemMap with the port's ID\&. All connections associated with the port are put onto a list, the multiplicity is reevaluated, and the program moves onto processing the next port on the list\&. Every time a new connector is accessed, the target is checked to see if is a leaf target with the same type as the source\&. If it is, an \fBISFSubsystem\fP physicallyConnectionType object is put onto a list\&. .PP -Additionally, to support multiple instances of ibds, is a a source instance and target instance name is created along side every connection\&. This name is the the root modules name followed by each subsystem which the connection's path goes through\&. This name is used if the program detect that target or source subsystem is used more than once\&. +Additionally, to support multiple instances of ibds, is a source instance and target instance name is created along side every connection\&. This name is the root modules name followed by each subsystem which the connection's path goes through\&. This name is used if the program detects that target or source subsystem is used more than once\&. .PP Exceptions are thrown in the instances where .PD 0 @@ -225,9 +225,9 @@ PHASE THREE FUNCTION .PP This function serves two purposes\&. The first is to convert the physicalConnectionSet to a physicalConnectionList\&. The second is to perform index checking and correction on ports of the cmdReg/cmd or com/cmdResponse type\&. .PP -The index checking/correction is done so multiplicities do not need to be specified for cmd/cmdReg or com/cmdResponse (with port names of seqCmdStatus and seqCmdBuff) blocks\&. The latter pair has the additional port name constraint because there are multiple other ports with the same cmdResponse type\&. Some of these port are not to be auto-indexed\&. This makes it easier for the user to add and remove these ports without needing to worry about if the indexes of the pairings match\&. +The index checking/correction is done so multiplicities do not need to be specified for cmd/cmdReg or com/cmdResponse (with port names of seqCmdStatus and seqCmdBuff) blocks\&. The latter pair has the additional port name constraint because there are multiple other ports with the same cmdResponse type\&. Some of these ports are not to be auto-indexed\&. This makes it easier for the user to add and remove these ports without needing to worry about if the indexes of the pairings match\&. .PP -The program redefines the indexes in numerical order\&. Even if initial indexes are given, for the origin of Cmd and the target of CmdReg, they are overwritten\&. They target index of Cmd is preserved and also is written to the source of CmdReg\&. +The program redefines the indexes in numerical order\&. Even if initial indexes are given, for the origin of Cmd and the target of CmdReg, they are overwritten\&. The target index of Cmd is preserved and also is written to the source of CmdReg\&. .PP METHODOLOGY .PD 0 @@ -301,7 +301,7 @@ All the elements in the module are iterated through using the Element root\&. .PP If the element type is Subsystem, the element is added to a list to be returned\&. .PP -If the element is an instance of a subsystem, the subsystemOwners map is updated, where each key (name of subsystem) is associated with an list of two string arrays\&. The first String corresponds to the instance name and the second corresponds to the name of the owner of the subsystem\&. +If the element is an instance of a subsystem, the subsystemOwners map is updated, where each key (name of subsystem) is associated with a list of two string arrays\&. The first String corresponds to the instance name and the second corresponds to the name of the owner of the subsystem\&. .PP \fBParameters:\fP .RS 4 diff --git a/Autocoders/MagicDrawCompPlugin/doc/xml/_process_i_s_f_topology_8java.xml b/Autocoders/MagicDrawCompPlugin/doc/xml/_process_i_s_f_topology_8java.xml index a1cd7e94c4..ca6dec2416 100644 --- a/Autocoders/MagicDrawCompPlugin/doc/xml/_process_i_s_f_topology_8java.xml +++ b/Autocoders/MagicDrawCompPlugin/doc/xml/_process_i_s_f_topology_8java.xml @@ -379,7 +379,7 @@ subsystemInstances.put(subsystemName,subsystemInstanceNameList.size()); -//Iteratethroughallownedobjectsoftheinputedsubsystem +//Iteratethroughallownedobjectsoftheinputtedsubsystem for(Elemente:subsystem.getOwnedElement()){ //Addconnectionstoamapwheretheconnectorendisakeyassociatedwithlistsofinput/outputconnections if(e.getHumanType().equals("PartProperty")||e.getHumanType().equals("ReferenceProperty")){ diff --git a/Autocoders/MagicDrawCompPlugin/doc/xml/classgov_1_1nasa_1_1jpl_1_1componentaction_1_1_i_s_f_component.xml b/Autocoders/MagicDrawCompPlugin/doc/xml/classgov_1_1nasa_1_1jpl_1_1componentaction_1_1_i_s_f_component.xml index d0217ecc4b..ca3cf4b755 100644 --- a/Autocoders/MagicDrawCompPlugin/doc/xml/classgov_1_1nasa_1_1jpl_1_1componentaction_1_1_i_s_f_component.xml +++ b/Autocoders/MagicDrawCompPlugin/doc/xml/classgov_1_1nasa_1_1jpl_1_1componentaction_1_1_i_s_f_component.xml @@ -212,7 +212,7 @@ -Creates a new port object using the port Element inputed. This processes the port and can throw an exception if something in the port is illegal. It also adds the port into fillList. +Creates a new port object using the port Element inputted. This processes the port and can throw an exception if something in the port is illegal. It also adds the port into fillList. portElement @@ -259,7 +259,7 @@ -Creates a new port object using the port Element inputed. This processes the port and can throw an exception if something in the port is illegal. It also adds the port into fillList. +Creates a new port object using the port Element inputted. This processes the port and can throw an exception if something in the port is illegal. It also adds the port into fillList. portElement diff --git a/Autocoders/MagicDrawCompPlugin/doc/xml/classgov_1_1nasa_1_1jpl_1_1componentaction_1_1_i_s_f_subsystem.xml b/Autocoders/MagicDrawCompPlugin/doc/xml/classgov_1_1nasa_1_1jpl_1_1componentaction_1_1_i_s_f_subsystem.xml index 6165e392df..85b41596ed 100644 --- a/Autocoders/MagicDrawCompPlugin/doc/xml/classgov_1_1nasa_1_1jpl_1_1componentaction_1_1_i_s_f_subsystem.xml +++ b/Autocoders/MagicDrawCompPlugin/doc/xml/classgov_1_1nasa_1_1jpl_1_1componentaction_1_1_i_s_f_subsystem.xml @@ -841,7 +841,7 @@ -Both getSourceConnEnd and getTargetConnEnd use this function. Incorporates error handling/checking. The function checks the direction property of the first stereotype found in each port of the connector. Depending on what the connector can see within and around the system, the funcion will return what it sees as the source and what is sees as the target. +Both getSourceConnEnd and getTargetConnEnd use this function. Incorporates error handling/checking. The function checks the direction property of the first stereotype found in each port of the connector. Depending on what the connector can see within and around the system, the function will return what it sees as the source and what is sees as the target. c diff --git a/Autocoders/MagicDrawCompPlugin/doc/xml/classgov_1_1nasa_1_1jpl_1_1componentaction_1_1_i_s_f_subsystem_1_1topology_model.xml b/Autocoders/MagicDrawCompPlugin/doc/xml/classgov_1_1nasa_1_1jpl_1_1componentaction_1_1_i_s_f_subsystem_1_1topology_model.xml index a688751ef8..0a6ab344df 100644 --- a/Autocoders/MagicDrawCompPlugin/doc/xml/classgov_1_1nasa_1_1jpl_1_1componentaction_1_1_i_s_f_subsystem_1_1topology_model.xml +++ b/Autocoders/MagicDrawCompPlugin/doc/xml/classgov_1_1nasa_1_1jpl_1_1componentaction_1_1_i_s_f_subsystem_1_1topology_model.xml @@ -181,7 +181,7 @@ -Used as a object to store the componentMap, physicalConnectionList, name, baseID, and instaneWindow. An object of this type is then sent to IsfSubXmlWriter and is used to write to the XML output file. +Used as an object to store the componentMap, physicalConnectionList, name, baseID, and instaneWindow. An object of this type is then sent to IsfSubXmlWriter and is used to write to the XML output file. diff --git a/Autocoders/MagicDrawCompPlugin/doc/xml/classgov_1_1nasa_1_1jpl_1_1componentaction_1_1_process_i_s_f_project.xml b/Autocoders/MagicDrawCompPlugin/doc/xml/classgov_1_1nasa_1_1jpl_1_1componentaction_1_1_process_i_s_f_project.xml index 23e06eb815..53c37cb120 100644 --- a/Autocoders/MagicDrawCompPlugin/doc/xml/classgov_1_1nasa_1_1jpl_1_1componentaction_1_1_process_i_s_f_project.xml +++ b/Autocoders/MagicDrawCompPlugin/doc/xml/classgov_1_1nasa_1_1jpl_1_1componentaction_1_1_process_i_s_f_project.xml @@ -248,7 +248,7 @@ -Creates ISFComponent objects for all components with associated ports and adds them toe the componentList. +Creates ISFComponent objects for all components with associated ports and adds them to the componentList. compElementList diff --git a/Autocoders/MagicDrawCompPlugin/doc/xml/classgov_1_1nasa_1_1jpl_1_1componentaction_1_1_process_i_s_f_topology.xml b/Autocoders/MagicDrawCompPlugin/doc/xml/classgov_1_1nasa_1_1jpl_1_1componentaction_1_1_process_i_s_f_topology.xml index 3c1ebb9072..32413ddbe8 100644 --- a/Autocoders/MagicDrawCompPlugin/doc/xml/classgov_1_1nasa_1_1jpl_1_1componentaction_1_1_process_i_s_f_topology.xml +++ b/Autocoders/MagicDrawCompPlugin/doc/xml/classgov_1_1nasa_1_1jpl_1_1componentaction_1_1_process_i_s_f_topology.xml @@ -318,7 +318,7 @@ -PHASE THREE FUNCTION This function serves two purposes. The first is to convert the physicalConnectionSet to a physicalConnecitonList. The second is to perform index checking and correction on ports of the cmdReg/cmd or com/cmdResponse type.The index checking/correction is done so multiplicites do not need to be specified for cmd/cmdReg or com/cmdResponse (with port names of seqCmdStatus and seqCmdBuff) blocks. The latter pair has the additinal port name constraint because there are multiple other ports with the same cmdResponse type. Some of these port are not to be auto-indexed. This makes it easier for the user to add and remove these ports without needing to worry about if the indexes of the pairings match.The program redefines the indexes in numerical order. Even if initial indexes are given, for the origin of Cmd and the target of CmdReg, they are overwritten. They target index of Cmd is preserved and also is written to the source of CmdReg.METHODOLOGY +PHASE THREE FUNCTION This function serves two purposes. The first is to convert the physicalConnectionSet to a physicalConnecitonList. The second is to perform index checking and correction on ports of the cmdReg/cmd or com/cmdResponse type.The index checking/correction is done so multiplicites do not need to be specified for cmd/cmdReg or com/cmdResponse (with port names of seqCmdStatus and seqCmdBuff) blocks. The latter pair has the additinal port name constraint because there are multiple other ports with the same cmdResponse type. Some of these ports are not to be auto-indexed. This makes it easier for the user to add and remove these ports without needing to worry about if the indexes of the pairings match.The program redefines the indexes in numerical order. Even if initial indexes are given, for the origin of Cmd and the target of CmdReg, they are overwritten. The target index of Cmd is preserved and also is written to the source of CmdReg.METHODOLOGY Iterate through all items of the physicalConnectionType and add those who have types of Cmd/CmdReg or those who have type of CmdResponse/Com and names of seqCmdStatus/seqCmdBuff to a list in a map where the index is the instance name of the associated cmdDispatch. @@ -386,7 +386,7 @@ pctSet Set of Physical Connection Types List of -PHASE ONE FUNCTION processModel has two main functions: to create a list of subsystems and to create a componentMap.All the elements in the module are iterated through using the Element root.If the element type is Subsystem, the element is added to a list to be returned.If the element is an instance of a subsystem, the subsystemOwners map is updated, where each key (name of subsystem) is associated with an list of two string arrays. The first String corresponds to the instance name and the second corresponds to the name of the owner of the subsystem. +PHASE ONE FUNCTION processModel has two main functions: to create a list of subsystems and to create a componentMap.All the elements in the module are iterated through using the Element root.If the element type is Subsystem, the element is added to a list to be returned.If the element is an instance of a subsystem, the subsystemOwners map is updated, where each key (name of subsystem) is associated with a list of two string arrays. The first String corresponds to the instance name and the second corresponds to the name of the owner of the subsystem. root @@ -488,7 +488,7 @@ pctSet Set of Physical Connection Types List of -PHASE TWO FUNCTION Iterates through the list of source ports and tries to find the final destination, while checking for errors.For each source port, the program traces down it's path by accessing the subsystemMap with the port's ID. All connections associated with the port are put onto a list, the multiplicity is reevaluated, and the program moves onto processing the next port on the list. Every time a new connector is accessed, the target is checked to see if is a leaf target with the same type as the source. If it is, an ISFSubsystem physicallyConnectionType object is put onto a list.Additionally, to support multiple instances of ibds, is a a source instance and target instance name is created along side every connection. This name is the the root modules name followed by each subsystem which the connection's path goes through. This name is used if the program detect that target or source subsystem is used more than once.Exceptions are thrown in the instances where +PHASE TWO FUNCTION Iterates through the list of source ports and tries to find the final destination, while checking for errors.For each source port, the program traces down it's path by accessing the subsystemMap with the port's ID. All connections associated with the port are put onto a list, the multiplicity is reevaluated, and the program moves onto processing the next port on the list. Every time a new connector is accessed, the target is checked to see if is a leaf target with the same type as the source. If it is, an ISFSubsystem physicallyConnectionType object is put onto a list.Additionally, to support multiple instances of ibds, is a source instance and target instance name is created along side every connection. This name is the root modules name followed by each subsystem which the connection's path goes through. This name is used if the program detects that target or source subsystem is used more than once.Exceptions are thrown in the instances where Source multiplicity is repeated by the same port onto multiple connectors. @@ -547,7 +547,7 @@ pctSet Set of Physical Connection Types List of Some connectors are ignored depending on the multiplicity of the previous source port. This multiplicity is recalculated for every connector. -When reached a port that is not owned by a subsystem, the type is checked. If the source port and the target port type do not matched, that target port is ignored. +When reached a port that is not owned by a subsystem, the type is checked. If the source port and the target port type do not match, that target port is ignored. This process goes on for each source port until either the target port is found, all the associated connectors have been done being searched, or a time out variable is reached. diff --git a/Autocoders/MagicDrawCompPlugin/doc/xml/indexpage.xml b/Autocoders/MagicDrawCompPlugin/doc/xml/indexpage.xml index 9566ff6cbe..f4198a3d84 100644 --- a/Autocoders/MagicDrawCompPlugin/doc/xml/indexpage.xml +++ b/Autocoders/MagicDrawCompPlugin/doc/xml/indexpage.xml @@ -58,7 +58,7 @@ ISFPort.java Helper object for port processing. IsfPortXmlWriter.java - Writes the processed ports to XML documents.Topology ProcessISFTopology.java - This object processes the model to create the topology XML diagrams. It can handle multiple subsystem within subsystems as well and multiple instantiations of subsystems and components. - ISFSubsystem.java - Contains many helper functions and objects used when process the model for the topology diagram. + ISFSubsystem.java - Contains many helper functions and objects used when processing the model for the topology diagram. IsfSubXmlWriter.java - Writes the processed model to an XML document. Exceptions diff --git a/Autocoders/MagicDrawCompPlugin/src/gov/nasa/jpl/componentaction/ISFSubsystem.java b/Autocoders/MagicDrawCompPlugin/src/gov/nasa/jpl/componentaction/ISFSubsystem.java index cb28879ffd..67ce41b58c 100644 --- a/Autocoders/MagicDrawCompPlugin/src/gov/nasa/jpl/componentaction/ISFSubsystem.java +++ b/Autocoders/MagicDrawCompPlugin/src/gov/nasa/jpl/componentaction/ISFSubsystem.java @@ -28,7 +28,7 @@ public class ISFSubsystem { /** - * Used as a object to store the componentMap, physicalConnectionList, name, baseID, and instanceWindow. An object of this type is then sent to IsfSubXmlWriter and is used to write to + * Used as an object to store the componentMap, physicalConnectionList, name, baseID, and instanceWindow. An object of this type is then sent to IsfSubXmlWriter and is used to write to * the XML output file. * */ diff --git a/Autocoders/MagicDrawCompPlugin/src/gov/nasa/jpl/componentaction/LoadIDConfig.java b/Autocoders/MagicDrawCompPlugin/src/gov/nasa/jpl/componentaction/LoadIDConfig.java index 1ab486a1c5..73fb166087 100644 --- a/Autocoders/MagicDrawCompPlugin/src/gov/nasa/jpl/componentaction/LoadIDConfig.java +++ b/Autocoders/MagicDrawCompPlugin/src/gov/nasa/jpl/componentaction/LoadIDConfig.java @@ -235,7 +235,7 @@ else if (el.getHumanType().equals("Subsystem")) { for(Element el : componentList){ NamedElement elNamed = (NamedElement) el; - //Check if current component had previous values assigned to the base ID and window id stereotype values. If so, a override warning message is printed to the console + //Check if current component had previous values assigned to the base ID and window id stereotype values. If so, an override warning message is printed to the console Object baseIdObject = StereotypesHelper.getStereotypePropertyFirst(el, componentInstanceStereotype, "BaseID"); Object windowRangeObject = StereotypesHelper.getStereotypePropertyFirst(el, componentInstanceStereotype, "Window"); if(baseIdObject != null){ diff --git a/Autocoders/MagicDrawCompPlugin/src/gov/nasa/jpl/componentaction/MainMenuConfigurator.java b/Autocoders/MagicDrawCompPlugin/src/gov/nasa/jpl/componentaction/MainMenuConfigurator.java index be209e0688..3937eeb6ea 100644 --- a/Autocoders/MagicDrawCompPlugin/src/gov/nasa/jpl/componentaction/MainMenuConfigurator.java +++ b/Autocoders/MagicDrawCompPlugin/src/gov/nasa/jpl/componentaction/MainMenuConfigurator.java @@ -92,7 +92,7 @@ *

Topology

* \ref ProcessISFTopology.java - This object processes the model to create the topology XML diagrams. It can handle multiple subsystem within subsystems as well and multiple instantiations of subsystems and components. *
- * \ref ISFSubsystem.java - Contains many helper functions and objects used when process the model for the topology diagram. + * \ref ISFSubsystem.java - Contains many helper functions and objects used when processing the model for the topology diagram. *
* \ref IsfSubXmlWriter.java - Writes the processed model to an XML document. * diff --git a/Autocoders/MagicDrawCompPlugin/src/gov/nasa/jpl/componentaction/ProcessISFProject.java b/Autocoders/MagicDrawCompPlugin/src/gov/nasa/jpl/componentaction/ProcessISFProject.java index a3eaf359b1..06f56d4a38 100644 --- a/Autocoders/MagicDrawCompPlugin/src/gov/nasa/jpl/componentaction/ProcessISFProject.java +++ b/Autocoders/MagicDrawCompPlugin/src/gov/nasa/jpl/componentaction/ProcessISFProject.java @@ -238,7 +238,7 @@ private static void processPorts(List portElementList) throws PortExcep } /** - * Creates ISFComponent objects for all components with associated ports and adds them toe the componentList. + * Creates ISFComponent objects for all components with associated ports and adds them to the componentList. * @param compElementList * @param stereotype * @throws PortException diff --git a/Autocoders/MagicDrawCompPlugin/src/gov/nasa/jpl/componentaction/ProcessISFTopology.java b/Autocoders/MagicDrawCompPlugin/src/gov/nasa/jpl/componentaction/ProcessISFTopology.java index 5fbc597a56..32915daca2 100644 --- a/Autocoders/MagicDrawCompPlugin/src/gov/nasa/jpl/componentaction/ProcessISFTopology.java +++ b/Autocoders/MagicDrawCompPlugin/src/gov/nasa/jpl/componentaction/ProcessISFTopology.java @@ -60,7 +60,7 @@ * Some connectors are ignored depending on the multiplicity of the previous source port. This multiplicity is recalculated for every connector. * *
  • - * When reached a port that is not owned by a subsystem, the type is checked. If the source port and the target port type do not matched, that target port is ignored. + * When reached a port that is not owned by a subsystem, the type is checked. If the source port and the target port type do not match, that target port is ignored. *
    • *
  • * This process goes on for each source port until either the target port is found, all the associated connectors have been done being searched, or a time out variable is reached. @@ -215,12 +215,12 @@ public static void process(Project proj, File pluginDir) throws IOException { *

    * * The index checking/correction is done so multiplicities do not need to be specified for cmd/cmdReg or com/cmdResponse (with port names of seqCmdStatus and seqCmdBuff) blocks. - * The latter pair has the additional port name constraint because there are multiple other ports with the same cmdResponse type. Some of these port are not to be auto-indexed. + * The latter pair has the additional port name constraint because there are multiple other ports with the same cmdResponse type. Some of these ports are not to be auto-indexed. * This makes it easier for the user to add and remove these ports without needing to worry about if the indexes of the pairings match. * *

    * - * The program redefines the indexes in numerical order. Even if initial indexes are given, for the origin of Cmd and the target of CmdReg, they are overwritten. They target index of Cmd is preserved and also is written to the source of CmdReg. + * The program redefines the indexes in numerical order. Even if initial indexes are given, for the origin of Cmd and the target of CmdReg, they are overwritten. The target index of Cmd is preserved and also is written to the source of CmdReg. * *

    * METHODOLOGY @@ -414,7 +414,7 @@ else if(qualified.equals("CDHCore::CDHSubsystem::sequenceRunner")){ * *

    * - * If the element is an instance of a subsystem, the subsystemOwners map is updated, where each key (name of subsystem) is associated with an list of two string arrays. + * If the element is an instance of a subsystem, the subsystemOwners map is updated, where each key (name of subsystem) is associated with a list of two string arrays. * The first String corresponds to the instance name and the second corresponds to the name of the owner of the subsystem. * * @param root Root of the system @@ -660,9 +660,9 @@ else if (e instanceof Connector) { * *

    * - * Additionally, to support multiple instances of ibds, is a a source instance and target instance name is created along side every connection. - * This name is the the root modules name followed by each subsystem which the connection's path goes through. - * This name is used if the program detect that target or source subsystem is used more than once. + * Additionally, to support multiple instances of ibds, is a source instance and target instance name is created along side every connection. + * This name is the root modules name followed by each subsystem which the connection's path goes through. + * This name is used if the program detects that target or source subsystem is used more than once. * *

    * @@ -729,7 +729,7 @@ else if(currentConnectorEnd.getLowerValue() != null){ ArrayList targetNameList = new ArrayList(); - //Iterate through all the connectors associated with the the currPort + //Iterate through all the connectors associated with the currPort while(i < 101){ //Infinite loop prevention. String previousConnectorTargetID = ""; //Used to figure out if current connector target and previous connector target are the same int previousConnectorTargetMult = 0; @@ -761,7 +761,7 @@ else if(currentConnectorEnd.getLowerValue() != null){ /* * if ( the current multiplicity is between the lower and upper multiplicities of the source connector AND the source multiplicity is not null OR * the source multiplicity is null and the target multiplicity is null OR - * the source multiplicity is null and the current multiplicity is equal to a counter which keeps track of how long we we have had separate connectors iterate on the same OR + * the source multiplicity is null and the current multiplicity is equal to a counter which keeps track of how long we have had separate connectors iterate on the same OR * the connectors associated with this port is one and the source multiplicity is null) */ diff --git a/Autocoders/Python/schema/default/common_elements.rng b/Autocoders/Python/schema/default/common_elements.rng index 61cc67c4da..0efdc87a85 100644 --- a/Autocoders/Python/schema/default/common_elements.rng +++ b/Autocoders/Python/schema/default/common_elements.rng @@ -118,7 +118,7 @@ - Defines a ID data type. Acceptable values formats include "10" , "0xA" , "xA". + Defines an ID data type. Acceptable values formats include "10" , "0xA" , "xA". ((0?x[0-9A-Fa-f]+)|\d+) diff --git a/Autocoders/Python/schema/default/topology_schema.rng b/Autocoders/Python/schema/default/topology_schema.rng index ecafdbe535..b1454b4e2f 100644 --- a/Autocoders/Python/schema/default/topology_schema.rng +++ b/Autocoders/Python/schema/default/topology_schema.rng @@ -228,7 +228,7 @@ Specifies the multiplicity or index of a port that is being connected to. Generally, - this value will be zero unless multiple indexes on the port exists. + this value will be zero unless multiple indexes of the port exist. diff --git a/Autocoders/Python/src/fprime_ac/generators/formatters.py b/Autocoders/Python/src/fprime_ac/generators/formatters.py index 7aef7eec6d..5385a85b71 100644 --- a/Autocoders/Python/src/fprime_ac/generators/formatters.py +++ b/Autocoders/Python/src/fprime_ac/generators/formatters.py @@ -582,7 +582,7 @@ def function_handler_name(self, id, name): def msgTypedefName(self, id, name, name_sep="AcMsg"): """ - Return the name of msg typedef from a import function name. + Return the name of msg typedef from an import function name. @param id: The module id. @param name: Original function name with '_' separation. @param name_sep: A string placed between the id and interface name @@ -636,7 +636,7 @@ def msgUnionArgName(self, msg_type): def msgTokenName(self, id, name): """ Return the name of msg typedef - from a input function name. + from an input function name. @param id: The module id. @param name: Original function name with '_' separation. """ @@ -657,7 +657,7 @@ def msgTokenName(self, id, name): def opcodeName(self, id, name): """ Return the name of command opcode - from a input function name. + from an input function name. @param id: The module id. @param name: Original function name with '_' separation. """ @@ -759,7 +759,7 @@ def bufferArgsPresent(self, args): def commentInArgsPresent(self, args): """ Given a list of argument tuples - return True if an comment for + return True if a comment for an arg is found, else return False. """ for arg in args: @@ -876,13 +876,13 @@ def formatFunCall(self, name, args, indent=0, prefix=""): def simpleFuncDraw(self, name, args, proto=True, indent=0): """ - This is a simply C function formatter. The arguments are a function + This is a simple C function formatter. The arguments are a function name, and its arguments. A string is returned that is a C code function declaration. The proto flag is used to properly terminate the function. """ - # Get the simply case out of the way. + # Get the simple case out of the way. if len(args) == 0: if proto == True: diff --git a/Autocoders/Python/src/fprime_ac/generators/templates/component/hpp.tmpl b/Autocoders/Python/src/fprime_ac/generators/templates/component/hpp.tmpl index 3c80a01298..6feb317023 100644 --- a/Autocoders/Python/src/fprime_ac/generators/templates/component/hpp.tmpl +++ b/Autocoders/Python/src/fprime_ac/generators/templates/component/hpp.tmpl @@ -908,7 +908,7 @@ $emit_non_port_params(8, $params) // Parameter load hook // ---------------------------------------------------------------------- - //! \brief Called whenever a parameters are loaded + //! \brief Called whenever a parameters is loaded //! //! This function does nothing by default. You may override it. //! diff --git a/Autocoders/Python/src/fprime_ac/generators/visitors/PortCppVisitor.py b/Autocoders/Python/src/fprime_ac/generators/visitors/PortCppVisitor.py index 5583f6fbbf..82f8228371 100644 --- a/Autocoders/Python/src/fprime_ac/generators/visitors/PortCppVisitor.py +++ b/Autocoders/Python/src/fprime_ac/generators/visitors/PortCppVisitor.py @@ -304,7 +304,7 @@ def privateVisit(self, obj): c = privatePortCpp.privatePortCpp() c.name = obj.get_type() tmp = [(a.get_name(), a.get_type(), a.get_modifier()) for a in obj.get_args()] - # Make a enum marker list here for template to use... + # Make an enum marker list here for template to use... c.enum_marker = [] for i in tmp: if isinstance(i[1], tuple): @@ -352,7 +352,7 @@ def finishSourceFilesVisit(self, obj): c.args = [ (a.get_name(), a.get_type(), a.get_modifier()) for a in obj.get_args() ] - # Make a enum marker list here for template to use... + # Make an enum marker list here for template to use... c.enum_marker = [] for i in c.args: if isinstance(i[1], tuple): diff --git a/Autocoders/Python/src/fprime_ac/models/Event.py b/Autocoders/Python/src/fprime_ac/models/Event.py index 5079ef65fc..efe6a0d3e0 100644 --- a/Autocoders/Python/src/fprime_ac/models/Event.py +++ b/Autocoders/Python/src/fprime_ac/models/Event.py @@ -1,7 +1,7 @@ # =============================================================================== # NAME: Event.py # -# DESCRIPTION: This is a Eve t meta-model sort of class. It is +# DESCRIPTION: This is a Event meta-model sort of class. It is # contained within a Component class as a list # of Event instances and is visited by the code # generators. diff --git a/Autocoders/Python/src/fprime_ac/models/Serialize.py b/Autocoders/Python/src/fprime_ac/models/Serialize.py index 235d36cbc0..e46ba7f0bc 100644 --- a/Autocoders/Python/src/fprime_ac/models/Serialize.py +++ b/Autocoders/Python/src/fprime_ac/models/Serialize.py @@ -1,7 +1,7 @@ # =============================================================================== # NAME: Serialize.py.py # -# DESCRIPTION: This is an Serialize meta-model class. It is +# DESCRIPTION: This is a Serialize meta-model class. It is # instanced for the generation of Serializable classes. # # USAGE: diff --git a/Autocoders/Python/src/fprime_ac/parsers/XmlComponentParser.py b/Autocoders/Python/src/fprime_ac/parsers/XmlComponentParser.py index d334013bb1..940c3b4936 100644 --- a/Autocoders/Python/src/fprime_ac/parsers/XmlComponentParser.py +++ b/Autocoders/Python/src/fprime_ac/parsers/XmlComponentParser.py @@ -1438,7 +1438,7 @@ def get_max_number(self): class CommandArg: """ - Data container for an command argument + Data container for a command argument """ def __init__(self, name, type, size=None, comment=None): diff --git a/Autocoders/Python/src/fprime_ac/parsers/XmlTopologyParser.py b/Autocoders/Python/src/fprime_ac/parsers/XmlTopologyParser.py index ac68f46b63..a8c6620f6d 100644 --- a/Autocoders/Python/src/fprime_ac/parsers/XmlTopologyParser.py +++ b/Autocoders/Python/src/fprime_ac/parsers/XmlTopologyParser.py @@ -122,7 +122,7 @@ def __init__(self, xml_file=None): self.__prepend_instance_name = True # # The deployment attribute added so that instance - # dictionaries are install in the correct place. + # dictionaries are installed in the correct place. # if "deployment" in e.attrib: self.__deployment = e.attrib["deployment"] diff --git a/Autocoders/Python/src/fprime_ac/utils/pyparsing.py b/Autocoders/Python/src/fprime_ac/utils/pyparsing.py index c0cd5a34a1..b0404112b3 100644 --- a/Autocoders/Python/src/fprime_ac/utils/pyparsing.py +++ b/Autocoders/Python/src/fprime_ac/utils/pyparsing.py @@ -1580,7 +1580,7 @@ def __init__( """ super().__init__() - # remove white space from quote chars - wont work anyway + # remove white space from quote chars - won't work anyway quoteChar = quoteChar.strip() if len(quoteChar) == 0: warnings.warn( @@ -2767,7 +2767,7 @@ def postParse(self, instring, loc, tokenlist): class Dict(TokenConverter): """Converter to return a repetitive expression as a list, but also as a dictionary. Each element can also be referenced using the first token in the expression as its key. - Useful for tabular report scraping when the first column can be used as a item key. + Useful for tabular report scraping when the first column can be used as an item key. """ def __init__(self, exprs): diff --git a/Autocoders/Python/test/enum/ExampleEnumAi.xml b/Autocoders/Python/test/enum/ExampleEnumAi.xml index 19ad7195ec..c10556e8fd 100644 --- a/Autocoders/Python/test/enum/ExampleEnumAi.xml +++ b/Autocoders/Python/test/enum/ExampleEnumAi.xml @@ -2,7 +2,7 @@ - + diff --git a/Drv/Ip/SocketReadTask.cpp b/Drv/Ip/SocketReadTask.cpp index 3a7f4254b8..8cf7dd95d9 100644 --- a/Drv/Ip/SocketReadTask.cpp +++ b/Drv/Ip/SocketReadTask.cpp @@ -31,7 +31,7 @@ void SocketReadTask::startSocketTask(const Fw::StringBase &name, FW_ASSERT(not m_task.isStarted()); // It is a coding error to start this task multiple times FW_ASSERT(not this->m_stop); // It is a coding error to stop the thread before it is started m_reconnect = reconnect; - // Note: the first step is for the IP socket to open the the port + // Note: the first step is for the IP socket to open the port Os::Task::TaskStatus stat = m_task.start(name, SocketReadTask::readTask, this, priority, stack, cpuAffinity); FW_ASSERT(Os::Task::TASK_OK == stat, static_cast(stat)); } diff --git a/Drv/Ip/SocketReadTask.hpp b/Drv/Ip/SocketReadTask.hpp index 3e95902ca7..2412c7b9f9 100644 --- a/Drv/Ip/SocketReadTask.hpp +++ b/Drv/Ip/SocketReadTask.hpp @@ -112,7 +112,7 @@ class SocketReadTask { /** * \brief returns a buffer to fill with data * - * Gets a reference to the a buffer to fill with data. This allows the component to determine how to provide a + * Gets a reference to a buffer to fill with data. This allows the component to determine how to provide a * buffer and the socket read task just fills said buffer. * * Note: this must be implemented by the inheritor @@ -122,7 +122,7 @@ class SocketReadTask { virtual Fw::Buffer getBuffer() = 0; /** - * \brief sends a buffer to filled with data + * \brief sends a buffer to be filled with data * * Sends the buffer gotten by getBuffer that has now been filled with data. This is used to delegate to the * component how to send back the buffer. diff --git a/Drv/Ip/UdpSocket.hpp b/Drv/Ip/UdpSocket.hpp index e8f48b039a..afdec15378 100644 --- a/Drv/Ip/UdpSocket.hpp +++ b/Drv/Ip/UdpSocket.hpp @@ -47,7 +47,7 @@ class UdpSocket : public IpSocket { * and port are configured using the `configureRecv` function call for UDP as it requires separate host/port pairs * for outgoing and incoming transmissions. Hostname DNS translation is left up to the caller and thus hostname must * be an IP address in dot-notation of the form "x.x.x.x". Port cannot be set to 0 as dynamic port assignment is not - * supported. It is possible to configure the UDP port as an single-direction send port only. + * supported. It is possible to configure the UDP port as a single-direction send port only. * * Note: delegates to `IpSocket::configure` * @@ -67,7 +67,7 @@ class UdpSocket : public IpSocket { * and port are configured using the `configureSend` function call for UDP as it requires separate host/port pairs * for outgoing and incoming transmissions. Hostname DNS translation is left up to the caller and thus hostname must * be an IP address in dot-notation of the form "x.x.x.x". Port cannot be set to 0 as dynamic port assignment is not - * supported. It is possible to configure the UDP port as an single-direction receive port only. + * supported. It is possible to configure the UDP port as a single-direction receive port only. * * \param hostname: socket uses for incoming transmissions. Must be of form x.x.x.x * \param port: port socket uses for incoming transmissions. Must NOT be 0. diff --git a/Drv/Ip/test/ut/SocketTestHelper.hpp b/Drv/Ip/test/ut/SocketTestHelper.hpp index 99b850e6e9..ec02921b63 100644 --- a/Drv/Ip/test/ut/SocketTestHelper.hpp +++ b/Drv/Ip/test/ut/SocketTestHelper.hpp @@ -14,7 +14,7 @@ namespace Test { /** - * Force a receive timeout on a socket such that it will not hang our testing despite the the normal recv behavior of + * Force a receive timeout on a socket such that it will not hang our testing despite the normal recv behavior of * "block forever" until it gets data. * @param socket: socket to make timeout */ diff --git a/Drv/LinuxGpioDriver/LinuxGpioDriverComponentImpl.cpp b/Drv/LinuxGpioDriver/LinuxGpioDriverComponentImpl.cpp index cc4d0165a5..42548968fe 100644 --- a/Drv/LinuxGpioDriver/LinuxGpioDriverComponentImpl.cpp +++ b/Drv/LinuxGpioDriver/LinuxGpioDriverComponentImpl.cpp @@ -134,7 +134,7 @@ namespace Drv { FW_ASSERT(fd != -1); - // TODO make value a enum or check its value + // TODO make value an enum or check its value const char *val = value ? "1" : "0"; const int len = 1; @@ -350,7 +350,7 @@ namespace Drv { /* * According to this link, poll will always have POLLERR set for the sys/class/gpio subsystem - * so cant check for it to look for error: + * so can't check for it to look for error: * http://stackoverflow.com/questions/27411013/poll-returns-both-pollpri-pollerr */ if (stat < 0) { diff --git a/Drv/LinuxI2cDriver/LinuxI2cDriverComponentImpl.cpp b/Drv/LinuxI2cDriver/LinuxI2cDriverComponentImpl.cpp index 416fad0b3a..60ca2e2154 100644 --- a/Drv/LinuxI2cDriver/LinuxI2cDriverComponentImpl.cpp +++ b/Drv/LinuxI2cDriver/LinuxI2cDriverComponentImpl.cpp @@ -67,7 +67,7 @@ namespace Drv { // Handler implementations for user-defined typed input ports // ---------------------------------------------------------------------- - // Note this this port handler is guarded, so we can make the ioctl call + // Note this port handler is guarded, so we can make the ioctl call Drv::I2cStatus LinuxI2cDriverComponentImpl :: write_handler( diff --git a/Drv/LinuxI2cDriver/LinuxI2cDriverComponentImplStub.cpp b/Drv/LinuxI2cDriver/LinuxI2cDriverComponentImplStub.cpp index 21056c6ab0..69db63a5b0 100644 --- a/Drv/LinuxI2cDriver/LinuxI2cDriverComponentImplStub.cpp +++ b/Drv/LinuxI2cDriver/LinuxI2cDriverComponentImplStub.cpp @@ -54,7 +54,7 @@ namespace Drv { // Handler implementations for user-defined typed input ports // ---------------------------------------------------------------------- - // Note this this port handler is guarded, so we can make the ioctl call + // Note this port handler is guarded, so we can make the ioctl call I2cStatus LinuxI2cDriverComponentImpl :: write_handler( diff --git a/Drv/LinuxSerialDriver/LinuxSerialDriverComponentImpl.cpp b/Drv/LinuxSerialDriver/LinuxSerialDriverComponentImpl.cpp index 337592b062..4993f1db26 100644 --- a/Drv/LinuxSerialDriver/LinuxSerialDriverComponentImpl.cpp +++ b/Drv/LinuxSerialDriver/LinuxSerialDriverComponentImpl.cpp @@ -59,7 +59,7 @@ namespace Drv { DEBUG_PRINT("Opening UART device %s\n", device); - // TODO cant use O_NDELAY and block (it is same as O_NONBLOCK), so removing NDELAY for now + // TODO can't use O_NDELAY and block (it is same as O_NONBLOCK), so removing NDELAY for now /* The O_NOCTTY flag tells UNIX that this program doesn't want to be the "controlling terminal" for that port. If you don't specify this then any input (such as keyboard abort signals and so forth) will affect your process. Programs like getty(1M/8) use this feature when starting the login process, but normally a user program does not want this behavior. diff --git a/Drv/TcpClient/TcpClientComponentImpl.hpp b/Drv/TcpClient/TcpClientComponentImpl.hpp index 1cf2cb9b50..67bb177e56 100644 --- a/Drv/TcpClient/TcpClientComponentImpl.hpp +++ b/Drv/TcpClient/TcpClientComponentImpl.hpp @@ -52,7 +52,7 @@ class TcpClientComponentImpl : public ByteStreamDriverModelComponentBase, public * \brief Configures the TcpClient settings but does not open the connection * * The TcpClientComponent needs to connect to a remote TCP server. This call configures the hostname, port and send - * timeouts for that socket connection. This call should be preformed on system startup before recv or send + * timeouts for that socket connection. This call should be performed on system startup before recv or send * are called. Note: hostname must be a dot-notation IP address of the form "x.x.x.x". DNS translation is left up * to the user. * @@ -86,7 +86,7 @@ class TcpClientComponentImpl : public ByteStreamDriverModelComponentBase, public /** * \brief returns a buffer to fill with data * - * Gets a reference to the a buffer to fill with data. This allows the component to determine how to provide a + * Gets a reference to a buffer to fill with data. This allows the component to determine how to provide a * buffer and the socket read task just fills said buffer. * * \return Fw::Buffer to fill with data @@ -94,7 +94,7 @@ class TcpClientComponentImpl : public ByteStreamDriverModelComponentBase, public Fw::Buffer getBuffer(); /** - * \brief sends a buffer to filled with data + * \brief sends a buffer to be filled with data * * Sends the buffer gotten by getBuffer that has now been filled with data. This is used to delegate to the * component how to send back the buffer. Ignores buffers with error status error. diff --git a/Drv/TcpServer/TcpServerComponentImpl.hpp b/Drv/TcpServer/TcpServerComponentImpl.hpp index 075f2f9671..004e30a589 100644 --- a/Drv/TcpServer/TcpServerComponentImpl.hpp +++ b/Drv/TcpServer/TcpServerComponentImpl.hpp @@ -53,7 +53,7 @@ class TcpServerComponentImpl : public ByteStreamDriverModelComponentBase, public * \brief Configures the TcpClient settings but does not open the connection * * The TcpClientComponent needs to connect to a remote TCP server. This call configures the hostname, port and - * send timeouts for that socket connection. This call should be preformed on system startup before recv or send + * send timeouts for that socket connection. This call should be performed on system startup before recv or send * are called. Note: hostname must be a dot-notation IP address of the form "x.x.x.x". DNS translation is left up * to the user. * @@ -106,7 +106,7 @@ class TcpServerComponentImpl : public ByteStreamDriverModelComponentBase, public /** * \brief returns a buffer to fill with data * - * Gets a reference to the a buffer to fill with data. This allows the component to determine how to provide a + * Gets a reference to a buffer to fill with data. This allows the component to determine how to provide a * buffer and the socket read task just fills said buffer. * * \return Fw::Buffer to fill with data @@ -114,7 +114,7 @@ class TcpServerComponentImpl : public ByteStreamDriverModelComponentBase, public Fw::Buffer getBuffer(); /** - * \brief sends a buffer to filled with data + * \brief sends a buffer to be filled with data * * Sends the buffer gotten by getBuffer that has now been filled with data. This is used to delegate to the * component how to send back the buffer. Ignores buffers with error status error. diff --git a/Drv/Udp/UdpComponentImpl.hpp b/Drv/Udp/UdpComponentImpl.hpp index 23128fd7f2..783a37a60d 100644 --- a/Drv/Udp/UdpComponentImpl.hpp +++ b/Drv/Udp/UdpComponentImpl.hpp @@ -52,7 +52,7 @@ class UdpComponentImpl : public ByteStreamDriverModelComponentBase, public Socke * \brief Configures the Udp send settings but does not open the connection * * The UdpComponent may need to send to a remote UDP port. This call configures the hostname, port and send - * timeouts for that socket connection. This call should be preformed on system startup before send is called. + * timeouts for that socket connection. This call should be performed on system startup before send is called. * Note: hostname must be a dot-notation IP address of the form "x.x.x.x". DNS translation is left up * to the user. * @@ -72,7 +72,7 @@ class UdpComponentImpl : public ByteStreamDriverModelComponentBase, public Socke * \brief Configures the Udp receive settings but does not open the connection * * The UdpComponent may need to receive from a remote udp port. This call configures the hostname and port of that - * source. This call should be preformed on system startup before recv or send are called. Note: hostname must be a + * source. This call should be performed on system startup before recv or send are called. Note: hostname must be a * dot-notation IP address of the form "x.x.x.x". DNS translation is left up to the user. * * \param hostname: ip address of remote tcp server in the form x.x.x.x @@ -106,7 +106,7 @@ class UdpComponentImpl : public ByteStreamDriverModelComponentBase, public Socke /** * \brief returns a buffer to fill with data * - * Gets a reference to the a buffer to fill with data. This allows the component to determine how to provide a + * Gets a reference to a buffer to fill with data. This allows the component to determine how to provide a * buffer and the socket read task just fills said buffer. * * \return Fw::Buffer to fill with data @@ -114,7 +114,7 @@ class UdpComponentImpl : public ByteStreamDriverModelComponentBase, public Socke Fw::Buffer getBuffer(); /** - * \brief sends a buffer to filled with data + * \brief sends a buffer to be filled with data * * Sends the buffer gotten by getBuffer that has now been filled with data. This is used to delegate to the * component how to send back the buffer. Ignores buffers with error status error. diff --git a/Fw/Buffer/Buffer.hpp b/Fw/Buffer/Buffer.hpp index 5b9fb76a01..ecd2da852b 100644 --- a/Fw/Buffer/Buffer.hpp +++ b/Fw/Buffer/Buffer.hpp @@ -37,7 +37,7 @@ namespace Fw { //! //! Fw::Buffer also comes with functions to return a representation of the data as a SerializeBufferBase. These two //! functions allow easy access to the data as if it were a serialize or deserialize buffer. This can aid in writing and -//! reading the wrapped data where as the standard serialize and deserialize methods treat the data as a pointer to +//! reading the wrapped data whereas the standard serialize and deserialize methods treat the data as a pointer to //! prevent excessive copying. //! class Buffer : public Fw::Serializable { diff --git a/Fw/Deprecate.hpp b/Fw/Deprecate.hpp index 15b0bae247..dfdb2afa34 100644 --- a/Fw/Deprecate.hpp +++ b/Fw/Deprecate.hpp @@ -1,6 +1,6 @@ // deprecate.hpp: // -// An minor implementation of compile-time deprecation for the fprime framework. +// A minor implementation of compile-time deprecation for the fprime framework. #ifndef FW_DEPRECATE_HPP #define FW_DEPRECATE_HPP diff --git a/Fw/Logger/test/ut/Main.cpp b/Fw/Logger/test/ut/Main.cpp index 39a363cc42..93e1b7511a 100644 --- a/Fw/Logger/test/ut/Main.cpp +++ b/Fw/Logger/test/ut/Main.cpp @@ -59,7 +59,7 @@ TEST(LoggerTests, BassicGoodLogger) { log.apply(logger); } /** - * Test that null-logging works function works. + * Test that null-logging function works. */ TEST(LoggerTests, BassicBadLogger) { // Basic discard logging diff --git a/Fw/Obj/ObjBase.hpp b/Fw/Obj/ObjBase.hpp index 09fe038a5c..0d81426060 100644 --- a/Fw/Obj/ObjBase.hpp +++ b/Fw/Obj/ObjBase.hpp @@ -25,7 +25,7 @@ namespace Fw { //! \class ObjBase //! \brief Brief class description //! - //! This class is is the base class of the ISF object class hierarchy. + //! This class is the base class of the ISF object class hierarchy. //! Depending on which features of the architecture are enabled, this class: //! 1) Stores an object name //! 2) Provides for object registration diff --git a/Fw/Port/InputSerializePort.cpp b/Fw/Port/InputSerializePort.cpp index 2088db50ce..c374b0fb47 100644 --- a/Fw/Port/InputSerializePort.cpp +++ b/Fw/Port/InputSerializePort.cpp @@ -25,7 +25,7 @@ namespace Fw { // The normal input ports perform deserialize() on the passed buffer, // which is what this status is based on. This is not the case for the - // InputSerializePort, so just return a okay status + // InputSerializePort, so just return an okay status return FW_SERIALIZE_OK; } diff --git a/Fw/Types/Serializable.hpp b/Fw/Types/Serializable.hpp index 5d0b890774..fcd6b14312 100644 --- a/Fw/Types/Serializable.hpp +++ b/Fw/Types/Serializable.hpp @@ -17,7 +17,7 @@ namespace Fw { FW_SERIALIZE_NO_ROOM_LEFT, //!< No room left in the buffer to serialize data FW_DESERIALIZE_BUFFER_EMPTY, //!< Deserialization buffer was empty when trying to read more data FW_DESERIALIZE_FORMAT_ERROR, //!< Deserialization data had incorrect values (unexpected data types) - FW_DESERIALIZE_SIZE_MISMATCH, //!< Data was left in in the buffer, but not enough to deserialize + FW_DESERIALIZE_SIZE_MISMATCH, //!< Data was left in the buffer, but not enough to deserialize FW_DESERIALIZE_TYPE_MISMATCH //!< Deserialized type ID didn't match } SerializeStatus; diff --git a/Os/Baremetal/Queue.cpp b/Os/Baremetal/Queue.cpp index e8a0d70820..a4534ffe1e 100644 --- a/Os/Baremetal/Queue.cpp +++ b/Os/Baremetal/Queue.cpp @@ -14,7 +14,7 @@ namespace Os { /** -* Wrapper class used to convert the the BufferQueue into a "handler" used by +* Wrapper class used to convert the BufferQueue into a "handler" used by * the Queue class. */ class BareQueueHandle { diff --git a/Os/Pthreads/MaxHeap/MaxHeap.hpp b/Os/Pthreads/MaxHeap/MaxHeap.hpp index 6414efbfc9..c897347d77 100644 --- a/Os/Pthreads/MaxHeap/MaxHeap.hpp +++ b/Os/Pthreads/MaxHeap/MaxHeap.hpp @@ -66,7 +66,7 @@ namespace Os { bool pop(NATIVE_INT_TYPE& value, NATIVE_UINT_TYPE& id); //! \brief Is the heap full? //! - //! Has the heap reach max size. No new items can be put on the + //! Has the heap reached max size. No new items can be put on the //! heap if this function returns true. //! bool isFull(); diff --git a/Os/SimpleQueueRegistry.hpp b/Os/SimpleQueueRegistry.hpp index bde0b9b4ca..42945dc683 100644 --- a/Os/SimpleQueueRegistry.hpp +++ b/Os/SimpleQueueRegistry.hpp @@ -4,9 +4,9 @@ * \brief Class declaration for a simple queue registry * * The simple object registry is meant to give a default implementation - * and an example of an queue registry. When the registry is instantiated, + * and an example of a queue registry. When the registry is instantiated, * it registers itself with the setQueueRegistry() static method. When - * queues in the system are instantiated, the will register themselves. + * queues in the system are instantiated, they will register themselves. * The registry can then query the instances about their names, sizes, * and high watermarks. * diff --git a/Svc/ActiveRateGroup/ActiveRateGroupImpl.hpp b/Svc/ActiveRateGroup/ActiveRateGroupImpl.hpp index 38f9573e59..d3139746fb 100644 --- a/Svc/ActiveRateGroup/ActiveRateGroupImpl.hpp +++ b/Svc/ActiveRateGroup/ActiveRateGroupImpl.hpp @@ -94,7 +94,7 @@ namespace Svc { //! \brief Task preamble //! //! This method is called prior to entering the message loop. - //! It issues and event indicating that the task has started. + //! It issues an event indicating that the task has started. //! void preamble(void); diff --git a/Svc/ActiveTextLogger/ActiveTextLoggerImpl.cpp b/Svc/ActiveTextLogger/ActiveTextLoggerImpl.cpp index a3f5f5d6f2..983740be56 100644 --- a/Svc/ActiveTextLogger/ActiveTextLoggerImpl.cpp +++ b/Svc/ActiveTextLogger/ActiveTextLoggerImpl.cpp @@ -108,7 +108,7 @@ namespace Svc { id,timeTag.getTimeBase(),timeTag.getSeconds(),timeTag.getUSeconds(),severityString,text.toChar()); } - // If there was a error then just return: + // If there was an error then just return: if (stat <= 0) { return; } diff --git a/Svc/ActiveTextLogger/ActiveTextLoggerImpl.hpp b/Svc/ActiveTextLogger/ActiveTextLoggerImpl.hpp index d26db815ca..ccdcc5f024 100644 --- a/Svc/ActiveTextLogger/ActiveTextLoggerImpl.hpp +++ b/Svc/ActiveTextLogger/ActiveTextLoggerImpl.hpp @@ -50,7 +50,7 @@ namespace Svc { //! \brief Set log file and max size //! - //! This is to create a optional log file to write all the messages to. + //! This is to create an optional log file to write all the messages to. //! The file will not be written to once the max size is hit. //! //! \param fileName The name of the file to create. Must be less than 80 characters. diff --git a/Svc/ActiveTextLogger/LogFile.cpp b/Svc/ActiveTextLogger/LogFile.cpp index ea12d02df6..ad621dd4f7 100644 --- a/Svc/ActiveTextLogger/LogFile.cpp +++ b/Svc/ActiveTextLogger/LogFile.cpp @@ -46,7 +46,7 @@ namespace Svc { // Print to file if there is one, and given a valid size: if (this->m_openFile && size > 0) { - // Make sure we wont exceed the maximum size: + // Make sure we won't exceed the maximum size: // Note: second condition in if statement is true if there is overflow // in the addition below U32 projectedSize = this->m_currentFileSize + size; @@ -57,7 +57,7 @@ namespace Svc { this->m_openFile = false; this->m_file.close(); } - // Wont exceed max size, so write to file: + // Won't exceed max size, so write to file: else { NATIVE_INT_TYPE writeSize = static_cast(size); diff --git a/Svc/ActiveTextLogger/LogFile.hpp b/Svc/ActiveTextLogger/LogFile.hpp index 85bb47b7bb..ae77f8d792 100644 --- a/Svc/ActiveTextLogger/LogFile.hpp +++ b/Svc/ActiveTextLogger/LogFile.hpp @@ -63,7 +63,7 @@ namespace Svc { // The max size of the text log file: U32 m_maxFileSize; - // True if there is currently a open file to write text logs to: + // True if there is currently an open file to write text logs to: bool m_openFile; // Current size of the file: diff --git a/Svc/ActiveTextLogger/test/ut/Tester.cpp b/Svc/ActiveTextLogger/test/ut/Tester.cpp index 37ce9340bc..cd55c108ff 100644 --- a/Svc/ActiveTextLogger/test/ut/Tester.cpp +++ b/Svc/ActiveTextLogger/test/ut/Tester.cpp @@ -171,7 +171,7 @@ namespace Svc { U64 tmp; printf("Testing writing text that is larger than FW_INTERNAL_INTERFACE_STRING_MAX_SIZE\n"); - // Cant test this b/c max size of TextLogString is 256 and + // Can't test this b/c max size of TextLogString is 256 and // FW_INTERNAL_INTERFACE_STRING_MAX_SIZE is 512 printf("Testing writing more than the max file size\n"); diff --git a/Svc/CmdDispatcher/CommandDispatcherImpl.hpp b/Svc/CmdDispatcher/CommandDispatcherImpl.hpp index 085a7130df..f5740c5c46 100644 --- a/Svc/CmdDispatcher/CommandDispatcherImpl.hpp +++ b/Svc/CmdDispatcher/CommandDispatcherImpl.hpp @@ -101,7 +101,7 @@ namespace Svc { void CMD_NO_OP_cmdHandler(FwOpcodeType opCode, U32 cmdSeq); //! \brief NO_OP with string command handler //! - //! A test command that receives a string an sends an event + //! A test command that receives a string and sends an event //! with the string as an argument //! //! \param opCode the NO_OP_STRING opcode. @@ -153,7 +153,7 @@ namespace Svc { //! but are not yet complete. When a new command opcode is received, //! the status port that would be used to report the completion status //! is checked. If it is connected, then an entry is placed in this table. - //! The "used" flag is set, and the "seq" member is set to the the + //! The "used" flag is set, and the "seq" member is set to the //! assigned sequence number for the command. The "opCode" field is //! used for the opcode, and the "callerPort" field is used to store //! the port number of the caller so the status can be reported back to diff --git a/Svc/CmdSequencer/test/ut/Immediate.hpp b/Svc/CmdSequencer/test/ut/Immediate.hpp index d740b99b42..cec20f6499 100644 --- a/Svc/CmdSequencer/test/ut/Immediate.hpp +++ b/Svc/CmdSequencer/test/ut/Immediate.hpp @@ -17,7 +17,7 @@ namespace Svc { namespace Immediate { - //! Test sequences with immediate commands followed by an marker + //! Test sequences with immediate commands followed by a marker class Tester : public ImmediateBase::Tester { diff --git a/Svc/CmdSequencer/test/ut/Relative.hpp b/Svc/CmdSequencer/test/ut/Relative.hpp index 16b3fda3f6..8631d8e475 100644 --- a/Svc/CmdSequencer/test/ut/Relative.hpp +++ b/Svc/CmdSequencer/test/ut/Relative.hpp @@ -17,7 +17,7 @@ namespace Svc { namespace Relative { - //! Test sequences with immediate commands followed by an marker + //! Test sequences with immediate commands followed by a marker class Tester : public MixedRelativeBase::Tester { diff --git a/Svc/FileDownlink/FileDownlink.hpp b/Svc/FileDownlink/FileDownlink.hpp index 13572a9a5b..5d172dba12 100644 --- a/Svc/FileDownlink/FileDownlink.hpp +++ b/Svc/FileDownlink/FileDownlink.hpp @@ -180,7 +180,7 @@ namespace Svc { public: - //! Construct an Warnings object + //! Construct a Warnings object Warnings(FileDownlink *const fileDownlink) : n(0), fileDownlink(fileDownlink) { } diff --git a/Svc/FileDownlink/test/ut/Tester.cpp b/Svc/FileDownlink/test/ut/Tester.cpp index 155d4b2d80..1cc2c009e5 100644 --- a/Svc/FileDownlink/test/ut/Tester.cpp +++ b/Svc/FileDownlink/test/ut/Tester.cpp @@ -215,7 +215,7 @@ namespace Svc { fileBufferOut.write(sourceFileName); FileBuffer fileBufferOutSubset(dataSubset, sizeof(dataSubset)); - // Test send partial past end of file, should return COMMAND_OK but raise an warning event. + // Test send partial past end of file, should return COMMAND_OK but raise a warning event. Fw::CommandResponse expResp = FILEDOWNLINK_COMMAND_FAILURES_DISABLED ? Fw::COMMAND_OK : Fw::COMMAND_VALIDATION_ERROR; this->sendFilePartial(sourceFileName, destFileName, expResp, sizeof(data), length); ASSERT_EVENTS_SIZE(1); diff --git a/Svc/FileUplink/FileUplink.hpp b/Svc/FileUplink/FileUplink.hpp index b75c9dbb09..dcdd9e6c9d 100644 --- a/Svc/FileUplink/FileUplink.hpp +++ b/Svc/FileUplink/FileUplink.hpp @@ -133,7 +133,7 @@ namespace Svc { public: - //! Construct an Warnings object + //! Construct a Warnings object Warnings(FileUplink *const fileUplink) : n(0), fileUplink(fileUplink) { } diff --git a/Svc/Health/HealthComponentImpl.hpp b/Svc/Health/HealthComponentImpl.hpp index f669c2115f..b2534e6d4b 100644 --- a/Svc/Health/HealthComponentImpl.hpp +++ b/Svc/Health/HealthComponentImpl.hpp @@ -22,7 +22,7 @@ namespace Svc { //! \brief Health component implementation class //! //! The health component iterates through each entry - //! in its table and checks its status. If an ping entry + //! in its table and checks its status. If a ping entry //! tracker is enabled, it will ping its corresponding port //! with a provided key. If a ping return is outstanding, //! a counter is decremented, and its value is checked diff --git a/Utils/Hash/HashBuffer.hpp b/Utils/Hash/HashBuffer.hpp index b14c74faec..f1193574d1 100644 --- a/Utils/Hash/HashBuffer.hpp +++ b/Utils/Hash/HashBuffer.hpp @@ -21,7 +21,7 @@ namespace Utils { //! \class HashBuffer - //! \brief An container class for holding a hash buffer + //! \brief A container class for holding a hash buffer //! class HashBuffer : public Fw::SerializeBufferBase { public: diff --git a/Utils/Hash/libcrc/CRC32.cpp b/Utils/Hash/libcrc/CRC32.cpp index da59d69b0b..0d0cf73d45 100644 --- a/Utils/Hash/libcrc/CRC32.cpp +++ b/Utils/Hash/libcrc/CRC32.cpp @@ -37,7 +37,7 @@ namespace Utils { local_hash_handle = update_crc_32(local_hash_handle, c); } HashBuffer bufferOut; - // For CRC32 we need to return the one's compliment of the result: + // For CRC32 we need to return the one's complement of the result: Fw::SerializeStatus status = bufferOut.serialize(~(local_hash_handle)); FW_ASSERT( Fw::FW_SERIALIZE_OK == status ); buffer = bufferOut; @@ -64,7 +64,7 @@ namespace Utils { final(HashBuffer& buffer) { HashBuffer bufferOut; - // For CRC32 we need to return the one's compliment of the result: + // For CRC32 we need to return the one's complement of the result: Fw::SerializeStatus status = bufferOut.serialize(~(this->hash_handle)); FW_ASSERT( Fw::FW_SERIALIZE_OK == status ); buffer = bufferOut; @@ -74,7 +74,7 @@ namespace Utils { final(U32 &hashvalue) { FW_ASSERT(sizeof(this->hash_handle) == sizeof(U32)); - // For CRC32 we need to return the one's compliment of the result: + // For CRC32 we need to return the one's complement of the result: hashvalue = ~(this->hash_handle); } diff --git a/Utils/Hash/libcrc/tst_crc.c b/Utils/Hash/libcrc/tst_crc.c index 7ec23cc8b6..e0fb812c31 100644 --- a/Utils/Hash/libcrc/tst_crc.c +++ b/Utils/Hash/libcrc/tst_crc.c @@ -21,7 +21,7 @@ * The file tst_crc.c contains a small sample program which * * demonstrates the use of the functions for calculating the * * CRC-CCITT, CRC-16 and CRC-32 values of data. The file cal- * - * culates the three different CRC's for a file who's name is * + * culates the three different CRC's for a file whose name is * * either provided at the command line, or typed in right * * after the program has started. * * * diff --git a/Utils/Types/CircularBuffer.hpp b/Utils/Types/CircularBuffer.hpp index ecba11288c..9d641f0249 100644 --- a/Utils/Types/CircularBuffer.hpp +++ b/Utils/Types/CircularBuffer.hpp @@ -42,7 +42,7 @@ class CircularBuffer { CircularBuffer(U8* const buffer, const NATIVE_UINT_TYPE size); /** - * Serialize a given buffer into this this circular buffer. Will not accept more data then + * Serialize a given buffer into this circular buffer. Will not accept more data then * space available. This means it will not overwrite existing data. * \param buffer: supplied buffer to be serialized. * \param size: size of the supplied buffer. diff --git a/cmake/support/parser/ai_parser.py b/cmake/support/parser/ai_parser.py index 70127bf834..1231a3c734 100755 --- a/cmake/support/parser/ai_parser.py +++ b/cmake/support/parser/ai_parser.py @@ -164,7 +164,7 @@ def read_fprime_import(import_type, root): def read_xml_file(root, import_base): """ - Reads and Ai.xml file, detects the type, and then pulls in the dependencies. Recursively looks for dependencies in + Reads an Ai.xml file, detects the type, and then pulls in the dependencies. Recursively looks for dependencies in import_dictionaries by inferring dependencies for each type of dictionary. :param root: input XML file to parsed, root of tree diff --git a/cmake/test/src/cmake.py b/cmake/test/src/cmake.py index fd9f252a19..0e72a0c44d 100644 --- a/cmake/test/src/cmake.py +++ b/cmake/test/src/cmake.py @@ -84,7 +84,7 @@ def run_cmake(build_path, options={}, capout=False): def run_make(target): """ Runs the make command to ensure that the CMake system can follow through and finish the build. - Note: this assumes that the provided application build properly. Thus, those unit tests should + Note: this assumes that the provided application built properly. Thus, those unit tests should run first. :param target: target to the make command diff --git a/config/FpConfig.hpp b/config/FpConfig.hpp index 4d403ebb11..0494436153 100644 --- a/config/FpConfig.hpp +++ b/config/FpConfig.hpp @@ -67,7 +67,7 @@ #endif #ifndef FwEventIdType -#define FwEventIdType U32 //!< Type representation for a event id +#define FwEventIdType U32 //!< Type representation for an event id #endif #ifndef FwPrmIdType @@ -235,7 +235,7 @@ #define FW_CMD_STRING_MAX_SIZE 40 //!< Max character size of command string arguments #endif -// Normally when a command is deserialized, the handler checks to see if there any any leftover +// Normally when a command is deserialized, the handler checks to see if there are any leftover // bytes in the buffer. If there are, it assumes that the command was corrupted somehow since // the serialized size should match the serialized size of the argument list. In some cases, // command buffers are padded so the data can be larger than the serialized size of the command. @@ -341,7 +341,7 @@ enum TimeBase { #define FW_CONTEXT_DONT_CARE 0xFF //!< Don't care value for time contexts in sequences #endif -// These setting configure whether or not the timebase and context values for the Fw::Time +// These settings configure whether or not the timebase and context values for the Fw::Time // class are used. Some systems may not use or need those fields #ifndef FW_USE_TIME_BASE