Skip to content

Commit fdc2347

Browse files
saxbophonesaxbophone
committed
Update documentation
1 parent 5def2ba commit fdc2347

File tree

9 files changed

+9
-11
lines changed

9 files changed

+9
-11
lines changed

‎docs/backend__pbm_8h.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@
121121
<dl class="section remark"><dt>Remarks</dt><dd>Reference materials used for the PBM format are located at <a href="http://netpbm.sourceforge.net/doc/pbm.html">http://netpbm.sourceforge.net/doc/pbm.html</a></dd></dl>
122122
<dl class="section author"><dt>Author</dt><dd>Joshua Saxby &lt;joshua.a.saxby+TNOPLuc8vM==.com </dd></dl>
123123
<dl class="section date"><dt>Date</dt><dd>2016, 2017</dd></dl>
124-
<dl class="section copyright"><dt>Copyright</dt><dd>Copyright (C) Joshua Saxby 2016</dd>
124+
<dl class="section copyright"><dt>Copyright</dt><dd>Copyright (C) Joshua Saxby 2016, 2017</dd>
125125
<dd>
126126
This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed with this file, You can obtain one at <a href="http://mozilla.org/MPL/2.0/">http://mozilla.org/MPL/2.0/</a>. </dd></dl>
127127
</div><h2 class="groupheader">Function Documentation</h2>

‎docs/backend__png_8h.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,7 @@
129129
<dl class="section note"><dt>Note</dt><dd>PNG output support may have not been enabled in the compiled version of libsxbp that you have. If support is not enabled, the library boolean constant SXBP_PNG_SUPPORT will be set to false and the one public function defined in this unit will return SXBP_NOT_IMPLEMENTED.</dd></dl>
130130
<dl class="section author"><dt>Author</dt><dd>Joshua Saxby &lt;joshua.a.saxby+TNOPLuc8vM==.com </dd></dl>
131131
<dl class="section date"><dt>Date</dt><dd>2016, 2017</dd></dl>
132-
<dl class="section copyright"><dt>Copyright</dt><dd>Copyright (C) Joshua Saxby 2016</dd>
132+
<dl class="section copyright"><dt>Copyright</dt><dd>Copyright (C) Joshua Saxby 2016, 2017</dd>
133133
<dd>
134134
This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed with this file, You can obtain one at <a href="http://mozilla.org/MPL/2.0/">http://mozilla.org/MPL/2.0/</a>. </dd></dl>
135135
</div><h2 class="groupheader">Function Documentation</h2>

‎docs/index.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@
8181
<div class="title">libsxbp ![libsxbp](libsxbp.png "libsxbp") </div> </div>
8282
</div><!--header-->
8383
<div class="contents">
84-
<div class="textblock"><p><a href="https://travis-ci.org/saxbophone/libsxbp"></a></p>
84+
<div class="textblock"><p><a href="https://travis-ci.org/saxbophone/libsxbp"></a> <a href="https://opensource.org/licenses/MPL-2.0"></a> <a href="http://saxbophone.github.io/libsxbp/"><b>[Documentation]</b></a></p>
8585
<p>Experimental generation of 2D spiralling lines based on input binary data.</p>
8686
<p>This a C library implementing an experimental idea I had for generating procedural shapes. The library takes input as sequences of bytes and turns the 1s and 0s into a kind of <em>right-angled spiral</em>, with the changes in direction of the line encoding the binary data in a lossless manner.</p>
8787
<p>Following Linus Torvalds' example, I have egotistically named this invention the **_saxbospiral_**, after my own online handle. At the time of writing, I couldn't think of a better name for it.</p>

‎docs/initialise_8h.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,7 @@
124124
<div class="textblock"><p>This compilation unit provides basic functions to initialise a spiral. </p>
125125
<dl class="section author"><dt>Author</dt><dd>Joshua Saxby &lt;joshua.a.saxby+TNOPLuc8vM==.com </dd></dl>
126126
<dl class="section date"><dt>Date</dt><dd>2016, 2017</dd></dl>
127-
<dl class="section copyright"><dt>Copyright</dt><dd>Copyright (C) Joshua Saxby 2016</dd>
127+
<dl class="section copyright"><dt>Copyright</dt><dd>Copyright (C) Joshua Saxby 2016, 2017</dd>
128128
<dd>
129129
This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed with this file, You can obtain one at <a href="http://mozilla.org/MPL/2.0/">http://mozilla.org/MPL/2.0/</a>. </dd></dl>
130130
</div><h2 class="groupheader">Function Documentation</h2>

‎docs/plot_8h.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,7 @@
125125
<div class="textblock"><p>This compilation unit provides functions for plotting and caching the points which make up the lines of a spiral. </p>
126126
<dl class="section author"><dt>Author</dt><dd>Joshua Saxby &lt;joshua.a.saxby+TNOPLuc8vM==.com </dd></dl>
127127
<dl class="section date"><dt>Date</dt><dd>2016, 2017</dd></dl>
128-
<dl class="section copyright"><dt>Copyright</dt><dd>Copyright (C) Joshua Saxby 2016</dd>
128+
<dl class="section copyright"><dt>Copyright</dt><dd>Copyright (C) Joshua Saxby 2016, 2017</dd>
129129
<dd>
130130
This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed with this file, You can obtain one at <a href="http://mozilla.org/MPL/2.0/">http://mozilla.org/MPL/2.0/</a>. </dd></dl>
131131
</div><h2 class="groupheader">Function Documentation</h2>

‎docs/render_8h.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -146,7 +146,7 @@
146146
<div class="textblock"><p>This compilation unit provides functions for rendering a spiral to a bitmap. </p>
147147
<dl class="section author"><dt>Author</dt><dd>Joshua Saxby &lt;joshua.a.saxby+TNOPLuc8vM==.com </dd></dl>
148148
<dl class="section date"><dt>Date</dt><dd>2016, 2017</dd></dl>
149-
<dl class="section copyright"><dt>Copyright</dt><dd>Copyright (C) Joshua Saxby 2016</dd>
149+
<dl class="section copyright"><dt>Copyright</dt><dd>Copyright (C) Joshua Saxby 2016, 2017</dd>
150150
<dd>
151151
This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed with this file, You can obtain one at <a href="http://mozilla.org/MPL/2.0/">http://mozilla.org/MPL/2.0/</a>. </dd></dl>
152152
</div><h2 class="groupheader">Typedef Documentation</h2>

‎docs/saxbospiral_8h.html‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -108,8 +108,6 @@
108108
Include dependency graph for saxbospiral.h:</div>
109109
<div class="dyncontent">
110110
<div class="center"><img src="saxbospiral_8h__incl.png" border="0" usemap="#sxbp_2saxbospiral_8h" alt=""/></div>
111-
<map name="sxbp_2saxbospiral_8h" id="sxbp_2saxbospiral_8h">
112-
</map>
113111
</div>
114112
</div><div class="textblock"><div class="dynheader">
115113
This graph shows which files directly or indirectly include this file:</div>
@@ -256,7 +254,7 @@
256254
<div class="textblock"><p>This compilation unit provides most of the data types used by the library, as well as defining some library constants and versioning functionality. </p>
257255
<dl class="section author"><dt>Author</dt><dd>Joshua Saxby &lt;joshua.a.saxby+TNOPLuc8vM==.com </dd></dl>
258256
<dl class="section date"><dt>Date</dt><dd>2016, 2017</dd></dl>
259-
<dl class="section copyright"><dt>Copyright</dt><dd>Copyright (C) Joshua Saxby 2016</dd>
257+
<dl class="section copyright"><dt>Copyright</dt><dd>Copyright (C) Joshua Saxby 2016, 2017</dd>
260258
<dd>
261259
This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed with this file, You can obtain one at <a href="http://mozilla.org/MPL/2.0/">http://mozilla.org/MPL/2.0/</a>. </dd></dl>
262260
</div><h2 class="groupheader">Macro Definition Documentation</h2>

‎docs/serialise_8h.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -168,7 +168,7 @@
168168
<div class="textblock"><p>This compilation unit provides functions for serialising spirals to and from byte sequences (which may be stored in files or any other form). </p>
169169
<dl class="section author"><dt>Author</dt><dd>Joshua Saxby &lt;joshua.a.saxby+TNOPLuc8vM==.com </dd></dl>
170170
<dl class="section date"><dt>Date</dt><dd>2016, 2017</dd></dl>
171-
<dl class="section copyright"><dt>Copyright</dt><dd>Copyright (C) Joshua Saxby 2016</dd>
171+
<dl class="section copyright"><dt>Copyright</dt><dd>Copyright (C) Joshua Saxby 2016, 2017</dd>
172172
<dd>
173173
This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed with this file, You can obtain one at <a href="http://mozilla.org/MPL/2.0/">http://mozilla.org/MPL/2.0/</a>. </dd></dl>
174174
</div><h2 class="groupheader">Enumeration Type Documentation</h2>

‎docs/solve_8h.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,7 @@
122122
<div class="textblock"><p>This compilation unit provides functions for calculating the length of all lines in a spiral such that the length of each line is at least 1 and none of them collide. </p>
123123
<dl class="section author"><dt>Author</dt><dd>Joshua Saxby &lt;joshua.a.saxby+TNOPLuc8vM==.com </dd></dl>
124124
<dl class="section date"><dt>Date</dt><dd>2016, 2017</dd></dl>
125-
<dl class="section copyright"><dt>Copyright</dt><dd>Copyright (C) Joshua Saxby 2016</dd>
125+
<dl class="section copyright"><dt>Copyright</dt><dd>Copyright (C) Joshua Saxby 2016, 2017</dd>
126126
<dd>
127127
This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed with this file, You can obtain one at <a href="http://mozilla.org/MPL/2.0/">http://mozilla.org/MPL/2.0/</a>. </dd></dl>
128128
</div><h2 class="groupheader">Function Documentation</h2>

0 commit comments

Comments
 (0)