Update class documentation

smartdevicelink · Oct 28, 2019 · 54700f0 · 54700f0
1 parent 80d298f
commit 54700f0
Show file tree

Hide file tree

Showing 102 changed files with 11,282 additions and 1,107 deletions.
diff --git a/docs/Classes.html b/docs/Classes.html
diff --git a/docs/Classes/SDLAddSubMenu.html b/docs/Classes/SDLAddSubMenu.html
@@ -6,10 +6,12 @@ <h3>Section Contents</h3>
   <li><a href="#section--initWithId:menuName:">-initWithId:menuName:</a></li>
   <li><a href="#section--initWithId:menuName:position:">-initWithId:menuName:position:</a></li>
   <li><a href="#section--initWithId:menuName:menuIcon:position:">-initWithId:menuName:menuIcon:position:</a></li>
+  <li><a href="#section--initWithId:menuName:menuLayout:menuIcon:position:">-initWithId:menuName:menuLayout:menuIcon:position:</a></li>
   <li><a href="#section-menuID">menuID</a></li>
   <li><a href="#section-position">position</a></li>
   <li><a href="#section-menuName">menuName</a></li>
   <li><a href="#section-menuIcon">menuIcon</a></li>
+  <li><a href="#section-menuLayout">menuLayout</a></li>
 </ul>
 
 <h3>Overview</h3>
@@ -55,7 +57,7 @@ <h3 id="section--initWithId:menuName:position:">
 
 
   <h4>Objective-C</h4>
-  <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithId</span><span class="p">:(</span><span class="n">UInt32</span><span class="p">)</span><span class="nv">menuId</span> <span class="nf">menuName</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">menuName</span> <span class="nf">position</span><span class="p">:(</span><span class="n">UInt8</span><span class="p">)</span><span class="nv">position</span> <span class="n">__deprecated_msg</span><span class="p">((</span><span class="s">"Use initWithId:menuName:menuIcon:position: instead"</span><span class="p">));</span></code></pre>
+  <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithId</span><span class="p">:(</span><span class="n">UInt32</span><span class="p">)</span><span class="nv">menuId</span> <span class="nf">menuName</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">menuName</span> <span class="nf">position</span><span class="p">:(</span><span class="n">UInt8</span><span class="p">)</span><span class="nv">position</span> <span class="n">__deprecated_msg</span><span class="p">(</span><span class="s">"Use initWithId:menuName:menuLayout:menuIcon:position: instead"</span><span class="p">);</span></code></pre>
 
 
   <h4>Swift</h4>
@@ -73,7 +75,7 @@ <h3 id="section--initWithId:menuName:menuIcon:position:">
 
 
   <h4>Objective-C</h4>
-  <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithId</span><span class="p">:(</span><span class="n">UInt32</span><span class="p">)</span><span class="nv">menuId</span> <span class="nf">menuName</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">menuName</span> <span class="nf">menuIcon</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="../Classes/SDLImage.html">SDLImage</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">icon</span> <span class="nf">position</span><span class="p">:(</span><span class="n">UInt8</span><span class="p">)</span><span class="nv">position</span><span class="p">;</span></code></pre>
+  <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithId</span><span class="p">:(</span><span class="n">UInt32</span><span class="p">)</span><span class="nv">menuId</span> <span class="nf">menuName</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">menuName</span> <span class="nf">menuIcon</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="../Classes/SDLImage.html">SDLImage</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">icon</span> <span class="nf">position</span><span class="p">:(</span><span class="n">UInt8</span><span class="p">)</span><span class="nv">position</span> <span class="n">__deprecated_msg</span><span class="p">(</span><span class="s">"Use initWithId:menuName:menuLayout:menuIcon:position: instead"</span><span class="p">);</span></code></pre>
 
 
   <h4>Swift</h4>
@@ -82,6 +84,24 @@ <h4>Swift</h4>
 
 
 
+  <h3 id="section--initWithId:menuName:menuLayout:menuIcon:position:">
+      -initWithId:menuName:menuLayout:menuIcon:position:
+  </h3>
+
+  <p>Undocumented</p>
+
+
+
+  <h4>Objective-C</h4>
+  <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithId</span><span class="p">:(</span><span class="n">UInt32</span><span class="p">)</span><span class="nv">menuId</span> <span class="nf">menuName</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">menuName</span> <span class="nf">menuLayout</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="../Type Definitions.html#/c:SDLMenuLayout.h@T@SDLMenuLayout">SDLMenuLayout</a></span><span class="p">)</span><span class="nv">menuLayout</span> <span class="nf">menuIcon</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="../Classes/SDLImage.html">SDLImage</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">icon</span> <span class="nf">position</span><span class="p">:(</span><span class="n">UInt8</span><span class="p">)</span><span class="nv">position</span><span class="p">;</span></code></pre>
+
+
+  <h4>Swift</h4>
+  <pre class="highlight swift"><code><span class="nf">init</span><span class="p">(</span><span class="n">id</span> <span class="nv">menuId</span><span class="p">:</span> <span class="kt">UInt32</span><span class="p">,</span> <span class="nv">menuName</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">menuLayout</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLMenuLayout.h@T@SDLMenuLayout">SDLMenuLayout</a></span><span class="p">?,</span> <span class="n"><a href="../Classes/SDLAddSubMenu.html#/c:objc(cs)SDLAddSubMenu(py)menuIcon">menuIcon</a></span> <span class="nv">icon</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLImage.html">SDLImage</a></span><span class="p">?,</span> <span class="nv">position</span><span class="p">:</span> <span class="kt">UInt8</span><span class="p">)</span></code></pre>
+
+
+
+
   <h3 id="section-menuID">
       menuID
   </h3>
@@ -173,4 +193,22 @@ <h4>Swift</h4>
 
 
 
+  <h3 id="section-menuLayout">
+      menuLayout
+  </h3>
+
+  <p>The sub-menu layout. See available menu layouts on SDLWindowCapability.menuLayoutsAvailable. Defaults to LIST.</p>
+
+
+
+  <h4>Objective-C</h4>
+  <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n"><a href="../Type Definitions.html#/c:SDLMenuLayout.h@T@SDLMenuLayout">SDLMenuLayout</a></span> <span class="n">menuLayout</span><span class="p">;</span></code></pre>
+
+
+  <h4>Swift</h4>
+  <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">menuLayout</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLMenuLayout.h@T@SDLMenuLayout">SDLMenuLayout</a></span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>
+
+
+
+
 </section>