Skip to content

Commit

Permalink
v1.4.1 Docs update
Browse files Browse the repository at this point in the history
  • Loading branch information
ValentinGrim committed Jul 4, 2022
1 parent 688d502 commit 81fac4f
Show file tree
Hide file tree
Showing 122 changed files with 1,367 additions and 1,202 deletions.
2 changes: 1 addition & 1 deletion bindings.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
# @file bindings.py
# @author Valentin Monnot
# @copyright SPDX-License-Identifier: MIT
# @version v1.4.0
# @version v1.4.1
# @date 2022

import os, sys
Expand Down
22 changes: 12 additions & 10 deletions docs/annotated.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="generator" content="Doxygen 1.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>py-dtbindings: Class List</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
Expand All @@ -27,7 +27,7 @@
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">py-dtbindings
&#160;<span id="projectnumber">1.3.0</span>
&#160;<span id="projectnumber">1.4.1</span>
</div>
<div id="projectbrief">This python &quot;lib&quot; aim is to extract devicetree bindings informations.</div>
</td>
Expand All @@ -36,10 +36,10 @@
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
Expand Down Expand Up @@ -91,19 +91,21 @@
<div class="textblock">Here are the classes, structs, unions and interfaces with brief descriptions:</div><div class="directory">
<div class="levels">[detail level <span onclick="javascript:toggleLevel(1);">1</span><span onclick="javascript:toggleLevel(2);">2</span>]</div><table class="directory">
<tr id="row_0_" class="even"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_0_" class="arrow" onclick="toggleFolder('0_')">&#9660;</span><span class="icona"><span class="icon">N</span></span><b>bindings</b></td><td class="desc"></td></tr>
<tr id="row_0_0_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classbindings_1_1_s_d_t_bindings.html" target="_self">SDTBindings</a></td><td class="desc">The main class that you should call </td></tr>
<tr id="row_0_1_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classbindings_1_1_binding.html" target="_self">Binding</a></td><td class="desc">This class represent a binding document </td></tr>
<tr id="row_0_2_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classbindings_1_1_prop.html" target="_self">Prop</a></td><td class="desc">This NamedTuple represent a single property and its value(s) </td></tr>
<tr id="row_0_3_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classbindings_1_1_main_prop.html" target="_self">MainProp</a></td><td class="desc">This NamedTuple represent a single property and its value(s) </td></tr>
<tr id="row_0_4_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classbindings_1_1_binding_props.html" target="_self">BindingProps</a></td><td class="desc">This class represent the binding properties of a <a class="el" href="classbindings_1_1_binding.html" title="This class represent a binding document.">Binding</a> class </td></tr>
<tr id="row_0_0_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classbindings_1_1_binding.html" target="_self">Binding</a></td><td class="desc">This class represent a binding document </td></tr>
<tr id="row_0_1_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classbindings_1_1_binding_props.html" target="_self">BindingProps</a></td><td class="desc">This class represent the binding properties of a <a class="el" href="classbindings_1_1_binding.html" title="This class represent a binding document.">Binding</a> class </td></tr>
<tr id="row_0_2_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classbindings_1_1_main_prop.html" target="_self">MainProp</a></td><td class="desc">This NamedTuple represent a single property and its value(s) </td></tr>
<tr id="row_0_3_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classbindings_1_1_prop.html" target="_self">Prop</a></td><td class="desc">This NamedTuple represent a single property and its value(s) </td></tr>
<tr id="row_0_4_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classbindings_1_1_s_d_t_bindings.html" target="_self">SDTBindings</a></td><td class="desc">The main class that you should call </td></tr>
</table>
</div><!-- directory -->
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
<li class="footer">Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.17 </li>
</ul>
</div>
</body>
Expand Down
6 changes: 3 additions & 3 deletions docs/annotated_dup.js
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
var annotated_dup =
[
[ "bindings", null, [
[ "SDTBindings", "classbindings_1_1_s_d_t_bindings.html", "classbindings_1_1_s_d_t_bindings" ],
[ "Binding", "classbindings_1_1_binding.html", "classbindings_1_1_binding" ],
[ "Prop", "classbindings_1_1_prop.html", null ],
[ "BindingProps", "classbindings_1_1_binding_props.html", "classbindings_1_1_binding_props" ],
[ "MainProp", "classbindings_1_1_main_prop.html", "classbindings_1_1_main_prop" ],
[ "BindingProps", "classbindings_1_1_binding_props.html", "classbindings_1_1_binding_props" ]
[ "Prop", "classbindings_1_1_prop.html", "classbindings_1_1_prop" ],
[ "SDTBindings", "classbindings_1_1_s_d_t_bindings.html", "classbindings_1_1_s_d_t_bindings" ]
] ]
];
53 changes: 13 additions & 40 deletions docs/bindings_8py.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="generator" content="Doxygen 1.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>py-dtbindings: bindings.py File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
Expand All @@ -27,7 +27,7 @@
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">py-dtbindings
&#160;<span id="projectnumber">1.3.0</span>
&#160;<span id="projectnumber">1.4.1</span>
</div>
<div id="projectbrief">This python &quot;lib&quot; aim is to extract devicetree bindings informations.</div>
</td>
Expand All @@ -36,10 +36,10 @@
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
Expand Down Expand Up @@ -113,14 +113,14 @@
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a586d676380df38e470a931fe93a1acea"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="bindings_8py.html#a586d676380df38e470a931fe93a1acea">bindings._init_dtschema_list</a> ()</td></tr>
<tr class="memdesc:a586d676380df38e470a931fe93a1acea"><td class="mdescLeft">&#160;</td><td class="mdescRight">Init a list of type from dtschemas. <a href="bindings_8py.html#a586d676380df38e470a931fe93a1acea">More...</a><br /></td></tr>
<tr class="separator:a586d676380df38e470a931fe93a1acea"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa5e6343bdeda4ed0e40ee0076f02da2d"><td class="memItemLeft" align="right" valign="top"><a id="aa5e6343bdeda4ed0e40ee0076f02da2d"></a>
def&#160;</td><td class="memItemRight" valign="bottom"><b>bindings._init_dtschema_list</b> (verbose)</td></tr>
<tr class="separator:aa5e6343bdeda4ed0e40ee0076f02da2d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a>
Variables</h2></td></tr>
<tr class="memitem:adb6bd868702ea08fb5cd119f4358bcb4"><td class="memItemLeft" align="right" valign="top"><a id="adb6bd868702ea08fb5cd119f4358bcb4"></a>
string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="bindings_8py.html#adb6bd868702ea08fb5cd119f4358bcb4">bindings.dtschema</a> = os.path.dirname(__file__) + &quot;/download/dtschema&quot;</td></tr>
string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="bindings_8py.html#adb6bd868702ea08fb5cd119f4358bcb4">bindings.dtschema</a> = &quot;./download/dtschema&quot;</td></tr>
<tr class="memdesc:adb6bd868702ea08fb5cd119f4358bcb4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Path to dtschema python library in order to access schemas. <br /></td></tr>
<tr class="separator:adb6bd868702ea08fb5cd119f4358bcb4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9a40866c6d8e153d7a6372ed29a4e160"><td class="memItemLeft" align="right" valign="top"><a id="a9a40866c6d8e153d7a6372ed29a4e160"></a>
Expand All @@ -134,38 +134,9 @@
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><dl class="section author"><dt>Author</dt><dd>Valentin Monnot </dd></dl>
<dl class="section copyright"><dt>Copyright</dt><dd>SPDX-License-Identifier: MIT </dd></dl>
<dl class="section version"><dt>Version</dt><dd>v1.2.1 </dd></dl>
<dl class="section version"><dt>Version</dt><dd>v1.4.1 </dd></dl>
<dl class="section date"><dt>Date</dt><dd>2022 </dd></dl>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="a586d676380df38e470a931fe93a1acea"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a586d676380df38e470a931fe93a1acea">&#9670;&nbsp;</a></span>_init_dtschema_list()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">def bindings._init_dtschema_list </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">

<p>Init a list of type from dtschemas. </p>
<p>This fct is called by SDTBindings <b>init</b>() It will load every YAML in dtschema python lib and update #nodes_types dict with the ones given by dtschemas </p>

</div>
</div>
<h2 class="groupheader">Variable Documentation</h2>
</div><h2 class="groupheader">Variable Documentation</h2>
<a id="a2385d3d176d6e273dbe3472704e12043"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2385d3d176d6e273dbe3472704e12043">&#9670;&nbsp;</a></span>dtschema_types</h2>

Expand All @@ -189,7 +160,9 @@ <h2 class="memtitle"><span class="permalink"><a href="#a2385d3d176d6e273dbe34727
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="bindings_8py.html">bindings.py</a></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
<li class="footer">Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.17 </li>
</ul>
</div>
</body>
Expand Down
4 changes: 2 additions & 2 deletions docs/bindings_8py.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@ var bindings_8py =
[
[ "SDTBindings", "classbindings_1_1_s_d_t_bindings.html", "classbindings_1_1_s_d_t_bindings" ],
[ "Binding", "classbindings_1_1_binding.html", "classbindings_1_1_binding" ],
[ "Prop", "classbindings_1_1_prop.html", null ],
[ "Prop", "classbindings_1_1_prop.html", "classbindings_1_1_prop" ],
[ "MainProp", "classbindings_1_1_main_prop.html", "classbindings_1_1_main_prop" ],
[ "BindingProps", "classbindings_1_1_binding_props.html", "classbindings_1_1_binding_props" ],
[ "_init_dtschema_list", "bindings_8py.html#a586d676380df38e470a931fe93a1acea", null ],
[ "_init_dtschema_list", "bindings_8py.html#aa5e6343bdeda4ed0e40ee0076f02da2d", null ],
[ "dtschema", "bindings_8py.html#adb6bd868702ea08fb5cd119f4358bcb4", null ],
[ "dtschema_types", "bindings_8py.html#a2385d3d176d6e273dbe3472704e12043", null ],
[ "nodes_types", "bindings_8py.html#a9a40866c6d8e153d7a6372ed29a4e160", null ]
Expand Down
12 changes: 7 additions & 5 deletions docs/classbindings_1_1_binding-members.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="generator" content="Doxygen 1.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>py-dtbindings: Member List</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
Expand All @@ -27,7 +27,7 @@
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">py-dtbindings
&#160;<span id="projectnumber">1.3.0</span>
&#160;<span id="projectnumber">1.4.1</span>
</div>
<div id="projectbrief">This python &quot;lib&quot; aim is to extract devicetree bindings informations.</div>
</td>
Expand All @@ -36,10 +36,10 @@
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
Expand Down Expand Up @@ -115,7 +115,9 @@
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
<li class="footer">Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.17 </li>
</ul>
</div>
</body>
Expand Down
Loading

0 comments on commit 81fac4f

Please sign in to comment.