Merge pull request #161 from saxbophone/develop

saxbophone · web-flow · commit cb12b5aa3e25 · 2017-01-17T14:19:09.000Z
v0.25.2 - Update copyright years and other doc embellishments.
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -15,7 +15,7 @@
 # begin basic metadata
 cmake_minimum_required(VERSION 3.0)
 
-project(sxbp VERSION 0.25.1 LANGUAGES C)
+project(sxbp VERSION 0.25.2 LANGUAGES C)
 
 # set default C standard to use (C99) if not already set
 if(NOT DEFINED LIBSXBP_C_STANDARD)
diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 # libsxbp ![libsxbp](libsxbp.png "libsxbp")
 
-[![Build Status](https://travis-ci.org/saxbophone/libsxbp.svg?branch=develop)](https://travis-ci.org/saxbophone/libsxbp)
+[![Build Status](https://travis-ci.org/saxbophone/libsxbp.svg?branch=develop)](https://travis-ci.org/saxbophone/libsxbp) [![License: MPL 2.0](https://img.shields.io/badge/License-MPL%202.0-brightgreen.svg)](https://opensource.org/licenses/MPL-2.0) [**[Documentation]**](http://saxbophone.github.io/libsxbp/)
 
 Experimental generation of 2D spiralling lines based on input binary data.
 
diff --git a/docs/backend__pbm_8h.html b/docs/backend__pbm_8h.html
@@ -121,7 +121,7 @@
 <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>
 <dl class="section author"><dt>Author</dt><dd>Joshua Saxby &lt;joshua.a.saxby+TNOPLuc8vM==.com </dd></dl>
 <dl class="section date"><dt>Date</dt><dd>2016, 2017</dd></dl>
-<dl class="section copyright"><dt>Copyright</dt><dd>Copyright (C) Joshua Saxby 2016</dd>
+<dl class="section copyright"><dt>Copyright</dt><dd>Copyright (C) Joshua Saxby 2016, 2017</dd>
 <dd>
 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>
 </div><h2 class="groupheader">Function Documentation</h2>
diff --git a/docs/backend__png_8h.html b/docs/backend__png_8h.html
@@ -129,7 +129,7 @@
 <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>
 <dl class="section author"><dt>Author</dt><dd>Joshua Saxby &lt;joshua.a.saxby+TNOPLuc8vM==.com </dd></dl>
 <dl class="section date"><dt>Date</dt><dd>2016, 2017</dd></dl>
-<dl class="section copyright"><dt>Copyright</dt><dd>Copyright (C) Joshua Saxby 2016</dd>
+<dl class="section copyright"><dt>Copyright</dt><dd>Copyright (C) Joshua Saxby 2016, 2017</dd>
 <dd>
 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>
 </div><h2 class="groupheader">Function Documentation</h2>
diff --git a/docs/index.html b/docs/index.html
@@ -81,7 +81,7 @@
 <div class="title">libsxbp ![libsxbp](libsxbp.png "libsxbp") </div>  </div>
 </div><!--header-->
 <div class="contents">
-<div class="textblock"><p><a href="https://travis-ci.org/saxbophone/libsxbp"></a></p>
+<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>
 <p>Experimental generation of 2D spiralling lines based on input binary data.</p>
 <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>
 <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>
diff --git a/docs/initialise_8h.html b/docs/initialise_8h.html
@@ -124,7 +124,7 @@
 <div class="textblock"><p>This compilation unit provides basic functions to initialise a spiral. </p>
 <dl class="section author"><dt>Author</dt><dd>Joshua Saxby &lt;joshua.a.saxby+TNOPLuc8vM==.com </dd></dl>
 <dl class="section date"><dt>Date</dt><dd>2016, 2017</dd></dl>
-<dl class="section copyright"><dt>Copyright</dt><dd>Copyright (C) Joshua Saxby 2016</dd>
+<dl class="section copyright"><dt>Copyright</dt><dd>Copyright (C) Joshua Saxby 2016, 2017</dd>
 <dd>
 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>
 </div><h2 class="groupheader">Function Documentation</h2>
diff --git a/docs/plot_8h.html b/docs/plot_8h.html
@@ -125,7 +125,7 @@
 <div class="textblock"><p>This compilation unit provides functions for plotting and caching the points which make up the lines of a spiral. </p>
 <dl class="section author"><dt>Author</dt><dd>Joshua Saxby &lt;joshua.a.saxby+TNOPLuc8vM==.com </dd></dl>
 <dl class="section date"><dt>Date</dt><dd>2016, 2017</dd></dl>
-<dl class="section copyright"><dt>Copyright</dt><dd>Copyright (C) Joshua Saxby 2016</dd>
+<dl class="section copyright"><dt>Copyright</dt><dd>Copyright (C) Joshua Saxby 2016, 2017</dd>
 <dd>
 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>
 </div><h2 class="groupheader">Function Documentation</h2>
diff --git a/docs/render_8h.html b/docs/render_8h.html
@@ -146,7 +146,7 @@
 <div class="textblock"><p>This compilation unit provides functions for rendering a spiral to a bitmap. </p>
 <dl class="section author"><dt>Author</dt><dd>Joshua Saxby &lt;joshua.a.saxby+TNOPLuc8vM==.com </dd></dl>
 <dl class="section date"><dt>Date</dt><dd>2016, 2017</dd></dl>
-<dl class="section copyright"><dt>Copyright</dt><dd>Copyright (C) Joshua Saxby 2016</dd>
+<dl class="section copyright"><dt>Copyright</dt><dd>Copyright (C) Joshua Saxby 2016, 2017</dd>
 <dd>
 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>
 </div><h2 class="groupheader">Typedef Documentation</h2>
diff --git a/docs/saxbospiral_8h.html b/docs/saxbospiral_8h.html
@@ -108,8 +108,6 @@
 Include dependency graph for saxbospiral.h:</div>
 <div class="dyncontent">
 <div class="center"><img src="saxbospiral_8h__incl.png" border="0" usemap="#sxbp_2saxbospiral_8h" alt=""/></div>
-<map name="sxbp_2saxbospiral_8h" id="sxbp_2saxbospiral_8h">
-</map>
 </div>
 </div><div class="textblock"><div class="dynheader">
 This graph shows which files directly or indirectly include this file:</div>
@@ -256,7 +254,7 @@
 <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>
 <dl class="section author"><dt>Author</dt><dd>Joshua Saxby &lt;joshua.a.saxby+TNOPLuc8vM==.com </dd></dl>
 <dl class="section date"><dt>Date</dt><dd>2016, 2017</dd></dl>
-<dl class="section copyright"><dt>Copyright</dt><dd>Copyright (C) Joshua Saxby 2016</dd>
+<dl class="section copyright"><dt>Copyright</dt><dd>Copyright (C) Joshua Saxby 2016, 2017</dd>
 <dd>
 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>
 </div><h2 class="groupheader">Macro Definition Documentation</h2>
diff --git a/docs/serialise_8h.html b/docs/serialise_8h.html
@@ -168,7 +168,7 @@
 <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>
 <dl class="section author"><dt>Author</dt><dd>Joshua Saxby &lt;joshua.a.saxby+TNOPLuc8vM==.com </dd></dl>
 <dl class="section date"><dt>Date</dt><dd>2016, 2017</dd></dl>
-<dl class="section copyright"><dt>Copyright</dt><dd>Copyright (C) Joshua Saxby 2016</dd>
+<dl class="section copyright"><dt>Copyright</dt><dd>Copyright (C) Joshua Saxby 2016, 2017</dd>
 <dd>
 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>
 </div><h2 class="groupheader">Enumeration Type Documentation</h2>
diff --git a/docs/solve_8h.html b/docs/solve_8h.html
@@ -122,7 +122,7 @@
 <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>
 <dl class="section author"><dt>Author</dt><dd>Joshua Saxby &lt;joshua.a.saxby+TNOPLuc8vM==.com </dd></dl>
 <dl class="section date"><dt>Date</dt><dd>2016, 2017</dd></dl>
-<dl class="section copyright"><dt>Copyright</dt><dd>Copyright (C) Joshua Saxby 2016</dd>
+<dl class="section copyright"><dt>Copyright</dt><dd>Copyright (C) Joshua Saxby 2016, 2017</dd>
 <dd>
 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>
 </div><h2 class="groupheader">Function Documentation</h2>
diff --git a/sxbp/initialise.c b/sxbp/initialise.c
@@ -2,7 +2,7 @@
  * This source file forms part of libsxbp, a library which generates
  * experimental 2D spiral-like shapes based on input binary data.
  *
- * Copyright (C) 2016, Joshua Saxby joshua.a.saxby+TNOPLuc8vM==@gmail.com
+ * Copyright (C) 2016, 2017, Joshua Saxby joshua.a.saxby+TNOPLuc8vM==@gmail.com
  *
  * 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
diff --git a/sxbp/initialise.h b/sxbp/initialise.h
@@ -11,7 +11,7 @@
  * @author Joshua Saxby <joshua.a.saxby+TNOPLuc8vM==@gmail.com
  * @date 2016, 2017
  *
- * @copyright Copyright (C) Joshua Saxby 2016
+ * @copyright Copyright (C) Joshua Saxby 2016, 2017
  *
  * @copyright
  * This Source Code Form is subject to the terms of the Mozilla Public
diff --git a/sxbp/plot.c b/sxbp/plot.c
@@ -2,7 +2,7 @@
  * This source file forms part of libsxbp, a library which generates
  * experimental 2D spiral-like shapes based on input binary data.
  *
- * Copyright (C) 2016, Joshua Saxby joshua.a.saxby+TNOPLuc8vM==@gmail.com
+ * Copyright (C) 2016, 2017, Joshua Saxby joshua.a.saxby+TNOPLuc8vM==@gmail.com
  *
  * 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
diff --git a/sxbp/plot.h b/sxbp/plot.h
@@ -12,7 +12,7 @@
  * @author Joshua Saxby <joshua.a.saxby+TNOPLuc8vM==@gmail.com
  * @date 2016, 2017
  *
- * @copyright Copyright (C) Joshua Saxby 2016
+ * @copyright Copyright (C) Joshua Saxby 2016, 2017
  *
  * @copyright
  * This Source Code Form is subject to the terms of the Mozilla Public
diff --git a/sxbp/render.c b/sxbp/render.c
@@ -2,7 +2,7 @@
  * This source file forms part of libsxbp, a library which generates
  * experimental 2D spiral-like shapes based on input binary data.
  *
- * Copyright (C) 2016, Joshua Saxby joshua.a.saxby+TNOPLuc8vM==@gmail.com
+ * Copyright (C) 2016, 2017, Joshua Saxby joshua.a.saxby+TNOPLuc8vM==@gmail.com
  *
  * 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
diff --git a/sxbp/render.h b/sxbp/render.h
@@ -12,7 +12,7 @@
  * @author Joshua Saxby <joshua.a.saxby+TNOPLuc8vM==@gmail.com
  * @date 2016, 2017
  *
- * @copyright Copyright (C) Joshua Saxby 2016
+ * @copyright Copyright (C) Joshua Saxby 2016, 2017
  *
  * @copyright
  * This Source Code Form is subject to the terms of the Mozilla Public
diff --git a/sxbp/render_backends/backend_pbm.c b/sxbp/render_backends/backend_pbm.c
@@ -2,7 +2,7 @@
  * This source file forms part of libsxbp, a library which generates
  * experimental 2D spiral-like shapes based on input binary data.
  *
- * Copyright (C) 2016, Joshua Saxby joshua.a.saxby+TNOPLuc8vM==@gmail.com
+ * Copyright (C) 2016, 2017, Joshua Saxby joshua.a.saxby+TNOPLuc8vM==@gmail.com
  *
  * 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
diff --git a/sxbp/render_backends/backend_pbm.h b/sxbp/render_backends/backend_pbm.h
@@ -15,7 +15,7 @@
  * @author Joshua Saxby <joshua.a.saxby+TNOPLuc8vM==@gmail.com
  * @date 2016, 2017
  *
- * @copyright Copyright (C) Joshua Saxby 2016
+ * @copyright Copyright (C) Joshua Saxby 2016, 2017
  *
  * @copyright
  * This Source Code Form is subject to the terms of the Mozilla Public
diff --git a/sxbp/render_backends/backend_png.c b/sxbp/render_backends/backend_png.c
@@ -2,7 +2,7 @@
  * This source file forms part of libsxbp, a library which generates
  * experimental 2D spiral-like shapes based on input binary data.
  *
- * Copyright (C) 2016, Joshua Saxby joshua.a.saxby+TNOPLuc8vM==@gmail.com
+ * Copyright (C) 2016, 2017, Joshua Saxby joshua.a.saxby+TNOPLuc8vM==@gmail.com
  *
  * 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
diff --git a/sxbp/render_backends/backend_png.h b/sxbp/render_backends/backend_png.h
@@ -17,7 +17,7 @@
  * @author Joshua Saxby <joshua.a.saxby+TNOPLuc8vM==@gmail.com
  * @date 2016, 2017
  *
- * @copyright Copyright (C) Joshua Saxby 2016
+ * @copyright Copyright (C) Joshua Saxby 2016, 2017
  *
  * @copyright
  * This Source Code Form is subject to the terms of the Mozilla Public
diff --git a/sxbp/saxbospiral.c b/sxbp/saxbospiral.c
@@ -2,7 +2,7 @@
  * This source file forms part of libsxbp, a library which generates
  * experimental 2D spiral-like shapes based on input binary data.
  *
- * Copyright (C) 2016, Joshua Saxby joshua.a.saxby+TNOPLuc8vM==@gmail.com
+ * Copyright (C) 2016, 2017, Joshua Saxby joshua.a.saxby+TNOPLuc8vM==@gmail.com
  *
  * 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
diff --git a/sxbp/saxbospiral.h b/sxbp/saxbospiral.h
@@ -13,7 +13,7 @@
  * @author Joshua Saxby <joshua.a.saxby+TNOPLuc8vM==@gmail.com
  * @date 2016, 2017
  *
- * @copyright Copyright (C) Joshua Saxby 2016
+ * @copyright Copyright (C) Joshua Saxby 2016, 2017
  *
  * @copyright
  * This Source Code Form is subject to the terms of the Mozilla Public
diff --git a/sxbp/serialise.c b/sxbp/serialise.c
@@ -2,7 +2,7 @@
  * This source file forms part of libsxbp, a library which generates
  * experimental 2D spiral-like shapes based on input binary data.
  *
- * Copyright (C) 2016, Joshua Saxby joshua.a.saxby+TNOPLuc8vM==@gmail.com
+ * Copyright (C) 2016, 2017, Joshua Saxby joshua.a.saxby+TNOPLuc8vM==@gmail.com
  *
  * 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
diff --git a/sxbp/serialise.h b/sxbp/serialise.h
@@ -12,7 +12,7 @@
  * @author Joshua Saxby <joshua.a.saxby+TNOPLuc8vM==@gmail.com
  * @date 2016, 2017
  *
- * @copyright Copyright (C) Joshua Saxby 2016
+ * @copyright Copyright (C) Joshua Saxby 2016, 2017
  *
  * @copyright
  * This Source Code Form is subject to the terms of the Mozilla Public
diff --git a/sxbp/solve.c b/sxbp/solve.c
@@ -2,7 +2,7 @@
  * This source file forms part of libsxbp, a library which generates
  * experimental 2D spiral-like shapes based on input binary data.
  *
- * Copyright (C) 2016, Joshua Saxby joshua.a.saxby+TNOPLuc8vM==@gmail.com
+ * Copyright (C) 2016, 2017, Joshua Saxby joshua.a.saxby+TNOPLuc8vM==@gmail.com
  *
  * 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
diff --git a/sxbp/solve.h b/sxbp/solve.h
@@ -13,7 +13,7 @@
  * @author Joshua Saxby <joshua.a.saxby+TNOPLuc8vM==@gmail.com
  * @date 2016, 2017
  *
- * @copyright Copyright (C) Joshua Saxby 2016
+ * @copyright Copyright (C) Joshua Saxby 2016, 2017
  *
  * @copyright
  * This Source Code Form is subject to the terms of the Mozilla Public
