Skip to content

Commit

Permalink
Fix minor typos in code comments/messages etc.
Browse files Browse the repository at this point in the history
  • Loading branch information
thnkslprpt committed Sep 17, 2021
1 parent 5b00858 commit 3501e25
Show file tree
Hide file tree
Showing 74 changed files with 121 additions and 121 deletions.
6 changes: 3 additions & 3 deletions Autocoders/MagicDrawCompPlugin/Doxyfile
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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.

Expand Down Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion Autocoders/MagicDrawCompPlugin/doc/html/search/search.js
Original file line number Diff line number Diff line change
Expand Up @@ -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)
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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}
Expand Down Expand Up @@ -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}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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}}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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}
Expand Down Expand Up @@ -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}
Expand Down Expand Up @@ -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}
Expand Down Expand Up @@ -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}
Expand Down
2 changes: 1 addition & 1 deletion Autocoders/MagicDrawCompPlugin/doc/latex/index.tex
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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)"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -379,7 +379,7 @@
<codeline lineno="575"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight></codeline>
<codeline lineno="576"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>subsystemInstances.put(subsystemName,<sp/>subsystemInstanceNameList.size());</highlight></codeline>
<codeline lineno="577"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight></codeline>
<codeline lineno="578"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="comment">//Iterate<sp/>through<sp/>all<sp/>owned<sp/>objects<sp/>of<sp/>the<sp/>inputed<sp/>subsystem</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="578"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="comment">//Iterate<sp/>through<sp/>all<sp/>owned<sp/>objects<sp/>of<sp/>the<sp/>inputted<sp/>subsystem</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="579"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keywordflow">for</highlight><highlight class="normal">(Element<sp/>e:<sp/>subsystem.getOwnedElement()){</highlight></codeline>
<codeline lineno="580"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="comment">//Add<sp/>connections<sp/>to<sp/>a<sp/>map<sp/>where<sp/>the<sp/>connector<sp/>end<sp/>is<sp/>a<sp/>key<sp/>associated<sp/>with<sp/>lists<sp/>of<sp/>input/output<sp/>connections</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="581"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keywordflow">if</highlight><highlight class="normal">(e.getHumanType().equals(</highlight><highlight class="stringliteral">&quot;Part<sp/>Property&quot;</highlight><highlight class="normal">)<sp/>||<sp/>e.getHumanType().equals(</highlight><highlight class="stringliteral">&quot;Reference<sp/>Property&quot;</highlight><highlight class="normal">)){</highlight></codeline>
Expand Down
Loading

0 comments on commit 3501e25

Please sign in to comment.