diff options
Diffstat (limited to 'docs/Classes/SDLSyncMsgVersion.html')
| -rw-r--r-- | docs/Classes/SDLSyncMsgVersion.html | 113 |
1 files changed, 0 insertions, 113 deletions
diff --git a/docs/Classes/SDLSyncMsgVersion.html b/docs/Classes/SDLSyncMsgVersion.html deleted file mode 100644 index 6ef12b852..000000000 --- a/docs/Classes/SDLSyncMsgVersion.html +++ /dev/null @@ -1,113 +0,0 @@ -<h1>SDLSyncMsgVersion Class Reference</h1> - -<h3>Section Contents</h3> - -<ul> - <li><a href="#section--initWithMajorVersion:minorVersion:patchVersion:">-initWithMajorVersion:minorVersion:patchVersion:</a></li> - <li><a href="#section-majorVersion">majorVersion</a></li> - <li><a href="#section-minorVersion">minorVersion</a></li> - <li><a href="#section-patchVersion">patchVersion</a></li> -</ul> - -<h3>Overview</h3> - -<p>Specifies the version number of the SDL V4 interface. This is used by both the application and SDL to declare what interface version each is using.</p> - -<p>@since SDL 1.0</p> - - -<section class="section task-group-section"> - <h3 id="section--initWithMajorVersion:minorVersion:patchVersion:"> - -initWithMajorVersion:minorVersion:patchVersion: - </h3> - - <p>Convenience init to describe the SDL version</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithMajorVersion</span><span class="p">:(</span><span class="n">UInt8</span><span class="p">)</span><span class="nv">majorVersion</span> - <span class="nf">minorVersion</span><span class="p">:(</span><span class="n">UInt8</span><span class="p">)</span><span class="nv">minorVersion</span> - <span class="nf">patchVersion</span><span class="p">:(</span><span class="n">UInt8</span><span class="p">)</span><span class="nv">patchVersion</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="nv">majorVersion</span><span class="p">:</span> <span class="kt">UInt8</span><span class="p">,</span> <span class="nv">minorVersion</span><span class="p">:</span> <span class="kt">UInt8</span><span class="p">,</span> <span class="nv">patchVersion</span><span class="p">:</span> <span class="kt">UInt8</span><span class="p">)</span></code></pre> - - - - <h4>Parameters</h4> - <dl> - <dt>majorVersion</dt> - <dd><p>The major version indicates versions that is not-compatible to previous versions</p></dd> - <dt>minorVersion</dt> - <dd><p>The minor version indicates a change to a previous version that should still allow to be run on an older version (with limited functionality)</p></dd> - <dt>patchVersion</dt> - <dd><p>Allows backward-compatible fixes to the API without increasing the minor version of the interface</p></dd> - </dl> - <div> - <h4>Return Value</h4> - <p>An SDLSyncMsgVersion object</p> - </div> - - <h3 id="section-majorVersion"> - majorVersion - </h3> - - <p>The major version indicates versions that is not-compatible to previous versions</p> - -<p>Required, Integer, 1 - 10</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nonatomic</span><span class="p">,</span> <span class="n">strong</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">majorVersion</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">majorVersion</span><span class="p">:</span> <span class="kt">NSNumber</span> <span class="o">&</span> <span class="kt"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> - - - - - <h3 id="section-minorVersion"> - minorVersion - </h3> - - <p>The minor version indicates a change to a previous version that should still allow to be run on an older version (with limited functionality)</p> - -<p>Required, Integer, 0 - 1000</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nonatomic</span><span class="p">,</span> <span class="n">strong</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">minorVersion</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">minorVersion</span><span class="p">:</span> <span class="kt">NSNumber</span> <span class="o">&</span> <span class="kt"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> - - - - - <h3 id="section-patchVersion"> - patchVersion - </h3> - - <p>Allows backward-compatible fixes to the API without increasing the minor version of the interface</p> - -<p>Optional, Integer, 0 - 1000</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nonatomic</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">patchVersion</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">patchVersion</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> <span class="o">&</span> <span class="kt"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</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> |