[Liblas-commits] hg: more doc work

[liblas-commits at liblas.org]

changeset 4b5523931254 in /Volumes/Data/www/liblas.org/hg
details: http://hg.liblas.orghg?cmd=changeset;node=4b5523931254
summary: more doc work

diffstat:

 doc/compilation.txt                |  6 ++++++
 doc/conf.py                        |  2 +-
 doc/development/specifications.txt |  7 ++++---
 python/liblas/header.py            |  2 +-
 python/liblas/vlr.py               |  6 ++++--
 5 files changed, 16 insertions(+), 7 deletions(-)

diffs (78 lines):

diff -r dd77f5e6c86b -r 4b5523931254 doc/compilation.txt
--- a/doc/compilation.txt	Wed May 26 19:40:52 2010 -0500
+++ b/doc/compilation.txt	Wed May 26 22:34:57 2010 -0500
@@ -14,6 +14,12 @@
 :Author: Howard Butler
 :Contact: hobu.inc at gmail dot com
 
+.. warning::
+    This document is only for the un-released 1.6 libLAS release.  Unfortunately,
+    there is no documentation for building libLAS 1.2.1 at this time, though 
+    it is a straightforward `Autoconf`_ setup for unix and nmake files for 
+    windows.
+    
 As of libLAS 1.6, `CMake`_ 2.8.1+ is the prescribed tool for building 
 libLAS from source as well as running unit tests. `CMake`_ is a cross-platform 
 build system that provides a number of benefits, and its usage ensures a 
diff -r dd77f5e6c86b -r 4b5523931254 doc/conf.py
--- a/doc/conf.py	Wed May 26 19:40:52 2010 -0500
+++ b/doc/conf.py	Wed May 26 22:34:57 2010 -0500
@@ -141,7 +141,7 @@
 html_sidebars = {
     '**': ['globaltoc.html', 'sourcelink.html', 'searchbox.html'],
 "index":["indexsidebar.html",'searchbox.html'],
-"docs":["indexsidebar.html",'searchbox.html']}
+"docs":['globaltoc.html',"indexsidebar.html",'searchbox.html']}
 
 # Additional templates that should be rendered to pages, maps page names to
 # template names.
diff -r dd77f5e6c86b -r 4b5523931254 doc/development/specifications.txt
--- a/doc/development/specifications.txt	Wed May 26 19:40:52 2010 -0500
+++ b/doc/development/specifications.txt	Wed May 26 22:34:57 2010 -0500
@@ -19,9 +19,10 @@
 VLR Key
 ----------------
 
-libLAS' VLR key is ``1209`` with keyname ``liblas``
-
-http://www.asprs.org/society/committees/lidar/lidar_format_keylist.html
+libLAS' VLR key is ``1209`` with keyname ``liblas``. See
+http://www.asprs.org/society/committees/lidar/lidar_format_keylist.html for
+the key list and Keys may be requested at
+http://www.asprs.org/lasform/keyform.html to register your own keys.
 
 .. _`ASPRS LAS 1.3`: http://liblas.org/_static/specifications/asprs_las_format_v13.pdf
 .. _`ASPRS LAS 1.2`: http://liblas.org/_static/specifications/asprs_las_format_v12.pdf
diff -r dd77f5e6c86b -r 4b5523931254 python/liblas/header.py
--- a/python/liblas/header.py	Wed May 26 19:40:52 2010 -0500
+++ b/python/liblas/header.py	Wed May 26 22:34:57 2010 -0500
@@ -338,7 +338,7 @@
             core.las.LASHeader_SetCreationDOY(self.handle, delta.days + 1)
         core.las.LASHeader_SetCreationYear(self.handle, value.year)
 
-    doc = """The header's date from a :class`datetime.datetime` instance.
+    doc = """The header's date from a :class:`datetime.datetime` instance.
 
         :arg value: :class:`datetime.datetime` instance or none to use the \
         current time
diff -r dd77f5e6c86b -r 4b5523931254 python/liblas/vlr.py
--- a/python/liblas/vlr.py	Wed May 26 19:40:52 2010 -0500
+++ b/python/liblas/vlr.py	Wed May 26 22:34:57 2010 -0500
@@ -48,7 +48,9 @@
 class VLR(object):
     def __init__(self, owned=True, handle=None):
         """
-        :keyword owned: flag to denote whether or not the VLR owns itself
+        :keyword owned: flag to denote whether or not the VLR owns itself.  \
+                        If it is owned, the underlying C object will be \
+                        destroyed once it goes out of scope.
         :keyword handle: raw ctypes object
 
         From the specification_:
@@ -182,5 +184,5 @@
     def set_data(self, data):
         pdata = ctypes.cast(data, ctypes.POINTER(ctypes.c_ubyte))
         core.las.LASVLR_SetData(self.handle, pdata, self.recordlength)
-    doc = """Raw data (in the form of :data:`ctypes.c_ubyte`)"""
+    doc = """Raw data (in the form of an array of :class:`ctypes.c_ubyte`)"""
     data = property(get_data, set_data, None, doc)