Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fixed typos in specification: #314

Merged
merged 1 commit into from
May 13, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions doxygen/src/csolution_schema.txt
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ Grouping element for csolution. No more than one such group can exist in a packa

\code
<csolution>
<template name="Basic csolution project" path="templates/blank" file="Blank.csolution.yml" copyto="Blank" condition="STM32H7S-Series">
<template name="Basic csolution project" path="templates/blank" file="Blank.csolution.yml" copy-to="Blank" condition="STM32H7S-Series">
<description>Create a basic project with empty main function</description>
</template>
<clayer path="layers/board/FRDM-MCXA153-MW" file="Board.clayer.yml" copy-to="board/FRDM-MCXA153" condition="FRDM-MCXA153-Board" />
Expand Down Expand Up @@ -106,8 +106,8 @@ A clayer section provides the information for accessing a software layer that is
\b Example:
\code
<csolution>
<clayer path="layers/board/FRDM-MCXA153-MW" file="Board.clayer.yml" copy-to="board/FRDM-MCXA153" condition="FRDM-MCXA153-Board" />
<clayer path="board/FRDM-MCXA153" file="Board.clayer.yml" condition="FRDM-MCXA153-Board"/>
<clayer type="Board" path="layers/board/FRDM-MCXA153-MW" file="Board.clayer.yml" copy-to="board/FRDM-MCXA153" condition="FRDM-MCXA153-Board" />
<clayer type="Board" path="board/FRDM-MCXA153" file="Board.clayer.yml" condition="FRDM-MCXA153-Board"/>
</csolution>
\endcode

Expand Down Expand Up @@ -181,7 +181,7 @@ A template section provide one or more project templates for starting a new *cso
\b Example:
\code
<csolution>
<template name="Basic csolution project" path="templates/blank" file="Blank.csolution.yml" copyto="Blank" condition="STM32H7S-Series">
<template name="Basic csolution project" path="templates/blank" file="Blank.csolution.yml" copy-to="Blank" condition="STM32H7S-Series">
<description>Create a basic project with empty main function</description>
</template>
<template name="TrustZone csolution project" path="templates/trustzone" file="TrustZone.csolution.yml" condition="STM32H7S-Series">
Expand Down
8 changes: 7 additions & 1 deletion doxygen/src/pdsc_format.txt
Original file line number Diff line number Diff line change
Expand Up @@ -454,7 +454,7 @@
\code
<package>
...
<description overview=".\Documentation\README.md>Keil MDK Middleware: File System, Network IPv4/IPv6, USB Device/Host</description>
<description overview="./Documentation/README.md">Keil MDK Middleware: File System, Network IPv4/IPv6, USB Device/Host</description>
...
</package>
\endcode
Expand Down Expand Up @@ -876,6 +876,12 @@
<td>\ref element_languages "LanguagesType"</td>
<td><0..1></td>
</tr>
<tr>
<td>\ref element_targets "targets"</td>
<td>Restrict a software pack to a list of devices, boards, or processor cores that are supported.</td>
<td>\ref element_targets "TargetsType"</td>
<td><0..1></td>
</tr>
</table>

<p>&nbsp;</p>
Expand Down Expand Up @@ -1199,7 +1205,7 @@
\endcode

\note You \b must \b not use Windows or Linux
<a href="http://en.wikipedia.org/wiki/Filename#Reserved_characters_and_words" target="_blank">reserved characters</a> for

Check warning on line 1208 in doxygen/src/pdsc_format.txt

View workflow job for this annotation

GitHub Actions / Build main documentation

200 OK
\em Cclass, \em Cgroup, and \em Csub names! Some development tools use these names to create a directory structure for the
software components in projects. Reserved characters are:
\verbatim
Expand Down Expand Up @@ -1506,7 +1512,7 @@
\endcode

\note You \b must \b not use Windows or Linux
<a href="http://en.wikipedia.org/wiki/Filename#Reserved_characters_and_words" target="_blank">reserved characters</a> for

Check warning on line 1515 in doxygen/src/pdsc_format.txt

View workflow job for this annotation

GitHub Actions / Build main documentation

200 OK
\em Hclass, \em Hgroup, and \em Hsub names! Reserved characters are:
\verbatim
< (less than)
Expand Down
Loading