element_info.html 8.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <title>/cprj/info</title>
  7. <title>CMSIS-Build: /cprj/info</title>
  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  9. <link href="cmsis.css" rel="stylesheet" type="text/css" />
  10. <script type="text/javascript" src="jquery.js"></script>
  11. <script type="text/javascript" src="dynsections.js"></script>
  12. <script type="text/javascript" src="printComponentTabs.js"></script>
  13. <link href="navtree.css" rel="stylesheet" type="text/css"/>
  14. <script type="text/javascript" src="resize.js"></script>
  15. <script type="text/javascript" src="navtree.js"></script>
  16. <script type="text/javascript">
  17. $(document).ready(initResizable);
  18. $(window).load(resizeHeight);
  19. </script>
  20. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  21. <script type="text/javascript" src="search/search.js"></script>
  22. <script type="text/javascript">
  23. $(document).ready(function() { searchBox.OnSelectItem(0); });
  24. </script>
  25. </head>
  26. <body>
  27. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  28. <div id="titlearea">
  29. <table cellspacing="0" cellpadding="0">
  30. <tbody>
  31. <tr style="height: 46px;">
  32. <td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td>
  33. <td style="padding-left: 0.5em;">
  34. <div id="projectname">CMSIS-Build
  35. &#160;<span id="projectnumber">Version 0.9.0 (beta)</span>
  36. </div>
  37. <div id="projectbrief">Tools, software frameworks, and work flows for productivity with CMSIS based projects</div>
  38. </td>
  39. </tr>
  40. </tbody>
  41. </table>
  42. </div>
  43. <!-- end header part -->
  44. <div id="CMSISnav" class="tabs1">
  45. <ul class="tablist">
  46. <script type="text/javascript">
  47. <!--
  48. writeComponentTabs.call(this);
  49. //-->
  50. </script>
  51. </ul>
  52. </div>
  53. <!-- Generated by Doxygen 1.8.6 -->
  54. <script type="text/javascript">
  55. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  56. </script>
  57. <div id="navrow1" class="tabs">
  58. <ul class="tablist">
  59. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  60. <li class="current"><a href="pages.html"><span>Usage&#160;and&#160;Description</span></a></li>
  61. <li>
  62. <div id="MSearchBox" class="MSearchBoxInactive">
  63. <span class="left">
  64. <img id="MSearchSelect" src="search/mag_sel.png"
  65. onmouseover="return searchBox.OnSearchSelectShow()"
  66. onmouseout="return searchBox.OnSearchSelectHide()"
  67. alt=""/>
  68. <input type="text" id="MSearchField" value="Search" accesskey="S"
  69. onfocus="searchBox.OnSearchFieldFocus(true)"
  70. onblur="searchBox.OnSearchFieldFocus(false)"
  71. onkeyup="searchBox.OnSearchFieldChange(event)"/>
  72. </span><span class="right">
  73. <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  74. </span>
  75. </div>
  76. </li>
  77. </ul>
  78. </div>
  79. </div><!-- top -->
  80. <div id="side-nav" class="ui-resizable side-nav-resizable">
  81. <div id="nav-tree">
  82. <div id="nav-tree-contents">
  83. <div id="nav-sync" class="sync"></div>
  84. </div>
  85. </div>
  86. <div id="splitbar" style="-moz-user-select:none;"
  87. class="ui-resizable-handle">
  88. </div>
  89. </div>
  90. <script type="text/javascript">
  91. $(document).ready(function(){initNavTree('element_info.html','');});
  92. </script>
  93. <div id="doc-content">
  94. <!-- window showing the filter options -->
  95. <div id="MSearchSelectWindow"
  96. onmouseover="return searchBox.OnSearchSelectShow()"
  97. onmouseout="return searchBox.OnSearchSelectHide()"
  98. onkeydown="return searchBox.OnSearchSelectKey(event)">
  99. <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Pages</a></div>
  100. <!-- iframe showing the search results (closed by default) -->
  101. <div id="MSearchResultsWindow">
  102. <iframe src="javascript:void(0)" frameborder="0"
  103. name="MSearchResults" id="MSearchResults">
  104. </iframe>
  105. </div>
  106. <div class="header">
  107. <div class="headertitle">
  108. <div class="title">/cprj/info </div> </div>
  109. </div><!--header-->
  110. <div class="contents">
  111. <div class="textblock"><p><b>Example</b> <em>info</em> element </p>
  112. <div class="fragment"><div class="line">...</div>
  113. <div class="line">&lt;info isLayer=<span class="stringliteral">&quot;false&quot;</span> &gt;</div>
  114. <div class="line"> &lt;description&gt;BSD Client application on top of MCB4300 Basic I/O layer with Ethernet&lt;/description&gt;</div>
  115. <div class="line"> &lt;category&gt;Wired Network, BSD Client, Board IO&lt;/category&gt;</div>
  116. <div class="line"> &lt;keywords&gt;MCB4300, MDK-Middleware, Network&lt;/keywords&gt;</div>
  117. <div class="line"> &lt;license&gt;BSD-3-Clause&lt;/license&gt;</div>
  118. <div class="line"> &lt;url&gt;https:<span class="comment">//github.com/ARM-software/cmsis-driver/examples/BSD_Client_MCB4300_IO/&lt;/url&gt;</span></div>
  119. <div class="line">&lt;/info&gt;</div>
  120. <div class="line">...</div>
  121. </div><!-- fragment --> <p>&#160;</p>
  122. <hr/>
  123. <table class="cmtable" summary="Element: info">
  124. <tr>
  125. <th>Parents </th><th colspan="3">Element Chain </th></tr>
  126. <tr>
  127. <td><a class="el" href="element_cprj.html">cprj</a> </td><td colspan="3"><a class="el" href="element_cprj.html">/cprj</a> </td></tr>
  128. <tr>
  129. <th>Attributes </th><th>Description </th><th>Type </th><th>Use </th></tr>
  130. <tr>
  131. <td>name </td><td>name of the layer </td><td><a class="el" href="cprj_types.html#type_restrictedStringType">RestrictedString</a> </td><td>required </td></tr>
  132. <tr>
  133. <td>isLayer </td><td>If 'true' then the project file is a layer description and not a complete project expected to create an output. Only layer descriptions can be added to an existing project, or a project is constructed from using only layer descriptions. By default a description is a project (false). </td><td>xs:boolean </td><td>required (if not default) </td></tr>
  134. <tr>
  135. <th>Child Elements </th><th>Description </th><th>Type </th><th>Occurrence </th></tr>
  136. <tr>
  137. <td>description </td><td>Brief description of the layer. </td><td>xs:string </td><td>0..* </td></tr>
  138. <tr>
  139. <td>keywords </td><td>Comma seperated list of keywords of this layer used by search tools. </td><td>xs:string </td><td>0..* </td></tr>
  140. <tr>
  141. <td>category </td><td>Comma separated list of predefined categories for this layer used by search tools. Predefined list TBD. </td><td>xs:string </td><td>0..* </td></tr>
  142. <tr>
  143. <td>license </td><td>License ruling for using files local to the layer using SPDX license ID from <a href="https://spdx.org/licenses/">https://spdx.org/licenses/</a>. Note: components have their own licenses. </td><td>xs:string </td><td>0..* </td></tr>
  144. <tr>
  145. <td><a class="el" href="element_info.html#element_url">url</a> </td><td>Specifies a public download location. Repository type and tag can be specified. </td><td>UrlType </td><td>0..* </td></tr>
  146. </table>
  147. <p>&#160;</p>
  148. <hr/>
  149. <h1><a class="anchor" id="element_url"></a>
  150. /cprj/info/url</h1>
  151. <p><b>Example</b> <em>url</em> element </p>
  152. <div class="fragment"><div class="line">...</div>
  153. <div class="line">&lt;info&gt;</div>
  154. <div class="line"> &lt;url type=<span class="stringliteral">&quot;git&quot;</span> tag=<span class="stringliteral">&quot;Rel-1.2.0&quot;</span>&gt;https:<span class="comment">//github/myOrg/myProj/Examples/myExample/&lt;/url&gt;</span></div>
  155. <div class="line">&lt;/info&gt;</div>
  156. <div class="line">...</div>
  157. </div><!-- fragment --> <p>&#160;</p>
  158. <hr/>
  159. <table class="cmtable" summary="Type: urlType">
  160. <tr>
  161. <th>Parents </th><th colspan="3">Element Chain </th></tr>
  162. <tr>
  163. <td><a class="el" href="element_info.html">info</a> </td><td colspan="3"><a class="el" href="element_info.html">/cprj/info</a> </td></tr>
  164. <tr>
  165. <th>Attributes </th><th>Description </th><th>Type </th><th>Use </th></tr>
  166. <tr>
  167. <td>type </td><td>repository type (git, svn, other) </td><td>xs:string </td><td>optional </td></tr>
  168. <tr>
  169. <td>tag </td><td>specifies the repository tag. </td><td>xs:string </td><td>optional </td></tr>
  170. </table>
  171. <p>&#160;</p>
  172. <hr/>
  173. </div></div><!-- contents -->
  174. </div><!-- doc-content -->
  175. <!-- start footer part -->
  176. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  177. <ul>
  178. <li class="navelem"><a class="el" href="cprjFormat_pg.html">Project Description (*.cprj) Format</a></li><li class="navelem"><a class="el" href="element_cprj.html">/cprj</a></li>
  179. <li class="footer">Generated on Thu Apr 9 2020 15:49:55 for CMSIS-Build Version 0.9.0 (beta) by Arm Ltd. All rights reserved.
  180. <!--
  181. <a href="http://www.doxygen.org/index.html">
  182. <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6
  183. -->
  184. </li>
  185. </ul>
  186. </div>
  187. </body>
  188. </html>