Merge pull request #162 from saxbophone/develop

v0.25.3 - Doc updates

Author: saxbophone

CMakeLists.txt

@@ -15,7 +15,7 @@
 # begin basic metadata
 cmake_minimum_required(VERSION 3.0)
 
-project(sxbp VERSION 0.25.2 LANGUAGES C)
+project(sxbp VERSION 0.25.3 LANGUAGES C)
 
 # set default C standard to use (C99) if not already set
 if(NOT DEFINED LIBSXBP_C_STANDARD)

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) [![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/)
+[![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/](https://img.shields.io/badge/Documentation-Doxygen-2C4AA8.svg)](http://saxbophone.github.io/libsxbp/)
 
 Experimental generation of 2D spiralling lines based on input binary data.
 

docs/backend__pbm_8h.html

@@ -152,8 +152,8 @@
 <p>Renders a bitmap image to a PBM image. </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramname">bitmap</td><td>Bitmap containing the image to render. </td></tr>
-    <tr><td class="paramname">buffer</td><td>[out] Buffer to write out the PBM image data to. </td></tr>
+    <tr><td class="paramdir"></td><td class="paramname">bitmap</td><td>Bitmap containing the image to render. </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">buffer</td><td>Buffer to write out the PBM image data to. </td></tr>
   </table>
   </dd>
 </dl>

docs/backend__png_8h.html

@@ -160,8 +160,8 @@
 <p>Renders a bitmap image to a PNG image. </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramname">bitmap</td><td>Bitmap containing the image to render. </td></tr>
-    <tr><td class="paramname">buffer</td><td>[out] Buffer to write out the PBM image data to. </td></tr>
+    <tr><td class="paramdir"></td><td class="paramname">bitmap</td><td>Bitmap containing the image to render. </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">buffer</td><td>Buffer to write out the PBM image data to. </td></tr>
   </table>
   </dd>
 </dl>

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> <a href="https://opensource.org/licenses/MPL-2.0"></a> <a href="http://saxbophone.github.io/libsxbp/"><b>[Documentation]</b></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/"></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>

docs/initialise_8h.html

@@ -213,8 +213,8 @@
 <p>This converts the 0s and 1s in the buffer data into UP, LEFT, DOWN, RIGHT instructions which are then used to build the pattern. Only the line directions are calculated at this point, all line lengths are 0.</p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramname">buffer</td><td>A buffer containing at least one byte of data, used to determine the directions of the lines in the spiral it will create. </td></tr>
-    <tr><td class="paramname">spiral</td><td>[out] Spiral object which the line directions will be written to. </td></tr>
+    <tr><td class="paramdir"></td><td class="paramname">buffer</td><td>A buffer containing at least one byte of data, used to determine the directions of the lines in the spiral it will create. </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">spiral</td><td>Spiral object which the line directions will be written to. </td></tr>
   </table>
   </dd>
 </dl>

docs/plot_8h.html

@@ -157,8 +157,8 @@
 <p>If there are any outstanding co-ordinates which haven't been stored in the spiral's internal cache, then these will be calculated and stored in the cache. Subsequent identical calls will not incur the overhead of re-calculating these co-ords, provided the lengths of any of the spiral's lines are not changed in the process.</p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramname">spiral</td><td>The spiral for which co-ords should be cached. </td></tr>
-    <tr><td class="paramname">limit</td><td>The highest index of line for which co-ords should be cached to. </td></tr>
+    <tr><td class="paramdir">[in,out]</td><td class="paramname">spiral</td><td>The spiral for which co-ords should be cached. </td></tr>
+    <tr><td class="paramdir"></td><td class="paramname">limit</td><td>The highest index of line for which co-ords should be cached to. </td></tr>
   </table>
   </dd>
 </dl>
@@ -219,11 +219,11 @@
 <p>The whole spiral may be calculated, or just a given segment of it. This is controlled by specifying which line to start at and which to end at.</p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramname">spiral</td><td>The spiral for which line co-ords should be calculated. </td></tr>
-    <tr><td class="paramname">output</td><td>[out] The co-ords array which calculated co-ords should be written to. </td></tr>
-    <tr><td class="paramname">start_point</td><td>The x/y co-ordinates at which the line being plotted originates at. </td></tr>
-    <tr><td class="paramname">start</td><td>The index of the first line which makes up the segment which is being calculated. </td></tr>
-    <tr><td class="paramname">end</td><td>The index of the line after the last line which makes up the segment which is being calculated. </td></tr>
+    <tr><td class="paramdir"></td><td class="paramname">spiral</td><td>The spiral for which line co-ords should be calculated. </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">output</td><td>The co-ords array which calculated co-ords should be written to. </td></tr>
+    <tr><td class="paramdir"></td><td class="paramname">start_point</td><td>The x/y co-ordinates at which the line being plotted originates at. </td></tr>
+    <tr><td class="paramdir"></td><td class="paramname">start</td><td>The index of the first line which makes up the segment which is being calculated. </td></tr>
+    <tr><td class="paramdir"></td><td class="paramname">end</td><td>The index of the line after the last line which makes up the segment which is being calculated. </td></tr>
   </table>
   </dd>
 </dl>

docs/render_8h.html

@@ -200,9 +200,9 @@ <h2 class="groupheader">Function Documentation</h2>
 <p>The lines of the spiral are plotted on a white background and the pixel data representing the resulting shape is written as data in a given image file format, using the callback function to achieve this conversion. The callback function should inspect the pixels of the bitmap passed to it and write the file data representing the bitmap in it's respective file format out to the buffer.</p>
 <p>The function signature of the callback is the same as that of the image rendering functions provided by the library: sxbp_render_backend_pbm and sxbp_render_backend_png. This allows one of these to be provided as the callback function, a convenient use of function chaining can achieve this like so: </p><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;sxbp_render_spiral_image(spiral, buffer, sxbp_render_backend_pbm);</div></div><!-- fragment --><dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramname">spiral</td><td>The spiral which should be rendered. </td></tr>
-    <tr><td class="paramname">buffer</td><td>[out] The data buffer to which the bytes of the image file should be written. </td></tr>
-    <tr><td class="paramname">image_writer_callback</td><td>A function pointer with the following signature: <div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;sxbp_status_t callback_name(sxbp_bitmap_t image, sxbp_buffer_t* buffer)</div></div><!-- fragment --> </td></tr>
+    <tr><td class="paramdir"></td><td class="paramname">spiral</td><td>The spiral which should be rendered. </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">buffer</td><td>The data buffer to which the bytes of the image file should be written. </td></tr>
+    <tr><td class="paramdir"></td><td class="paramname">image_writer_callback</td><td>A function pointer with the following signature: <div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;sxbp_status_t callback_name(sxbp_bitmap_t image, sxbp_buffer_t* buffer)</div></div><!-- fragment --> </td></tr>
   </table>
   </dd>
 </dl>
@@ -246,8 +246,8 @@ <h2 class="groupheader">Function Documentation</h2>
 <p>The lines of the spiral are plotted on a white background and the pixel data representing the resulting shape is written to the given image.</p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramname">spiral</td><td>The spiral which should be rendered. </td></tr>
-    <tr><td class="paramname">image</td><td>The bitmap to write the pixel data out to. </td></tr>
+    <tr><td class="paramdir"></td><td class="paramname">spiral</td><td>The spiral which should be rendered. </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">image</td><td>The bitmap to write the pixel data out to. </td></tr>
   </table>
   </dd>
 </dl>