diff options
Diffstat (limited to 'docs/Protocols/SDLLogTarget.html')
-rw-r--r-- | docs/Protocols/SDLLogTarget.html | 99 |
1 files changed, 99 insertions, 0 deletions
diff --git a/docs/Protocols/SDLLogTarget.html b/docs/Protocols/SDLLogTarget.html new file mode 100644 index 000000000..39d8813cc --- /dev/null +++ b/docs/Protocols/SDLLogTarget.html @@ -0,0 +1,99 @@ +<h1>SDLLogTarget Protocol Reference</h1> + +<h3>Section Contents</h3> + +<ul> + <li><a href="#section-+logger">+logger</a></li> + <li><a href="#section--setupLogger">-setupLogger</a></li> + <li><a href="#section--logWithLog:formattedLog:">-logWithLog:formattedLog:</a></li> + <li><a href="#section--teardownLogger">-teardownLogger</a></li> +</ul> + +<h3>Overview</h3> + +<p>Undocumented</p> + + +<section class="section task-group-section"> + <h3 id="section-+logger"> + +logger + </h3> + + <p>A simple convenience initializer to create the object. This <em>should not</em> start up the logger.</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n">id</span><span class="o"><</span><span class="n">SDLLogTarget</span><span class="o">></span><span class="p">)</span><span class="n">logger</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">static</span> <span class="kd">func</span> <span class="nf">logger</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLLogTarget</span></code></pre> + + + + <div> + <h4>Return Value</h4> + <p>An instance of the logger.</p> + </div> + + <h3 id="section--setupLogger"> + -setupLogger + </h3> + + <p>A call to setup the logger in whatever manner it needs to do so.</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">-</span> <span class="p">(</span><span class="n">BOOL</span><span class="p">)</span><span class="n">setupLogger</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">func</span> <span class="nf">setupLogger</span><span class="p">()</span> <span class="o">-></span> <span class="kt">Bool</span></code></pre> + + + + <div> + <h4>Return Value</h4> + <p>Whether or not the logger set up correctly.</p> + </div> + + <h3 id="section--logWithLog:formattedLog:"> + -logWithLog:formattedLog: + </h3> + + <p>Log a particular log using the model and the formatted log message to the target.</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">logWithLog</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">SDLLogModel</span> <span class="o">*</span><span class="p">)</span><span class="nv">log</span> + <span class="nf">formattedLog</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">stringLog</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">func</span> <span class="nf">log</span><span class="p">(</span><span class="n">withLog</span> <span class="nv">log</span><span class="p">:</span> <span class="kt">SDLLogModel</span><span class="p">,</span> <span class="n">formattedLog</span> <span class="nv">stringLog</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span></code></pre> + + + + <h4>Parameters</h4> + <dl> + <dt>log</dt> + <dd><p>The log model, if you can log additional data, such as the log level, use this</p></dd> + <dt>stringLog</dt> + <dd><p>The formatted message</p></dd> + </dl> + + <h3 id="section--teardownLogger"> + -teardownLogger + </h3> + + <p>Undocumented</p> + + + + + + +</section> |