[pdal-commits] [PDAL/PDAL] 5d5f5c: Documentation update

[GitHub]

  Branch: refs/heads/rework-docs
  Home:   https://github.com/PDAL/PDAL
  Commit: 5d5f5c0e6b0fc598f620670d12e3e1f73a5d114f
      https://github.com/PDAL/PDAL/commit/5d5f5c0e6b0fc598f620670d12e3e1f73a5d114f
  Author: Bradley J Chambers <brad.chambers at gmail.com>
  Date:   2014-10-29 (Wed, 29 Oct 2014)

  Changed paths:
    M doc/api/cpp/bounds.rst
    R doc/api/cpp/dimension.rst
    M doc/api/cpp/index.rst
    M doc/api/cpp/metadata.rst
    A doc/api/cpp/pointcontext.rst
    M doc/api/cpp/reader.rst
    R doc/api/cpp/schema.rst
    M doc/api/cpp/writer.rst
    R doc/apps.rst
    A doc/apps/delta.rst
    A doc/apps/diff.rst
    A doc/apps/ground.rst
    A doc/apps/index.rst
    A doc/apps/info.rst
    A doc/apps/pcl.rst
    A doc/apps/pipeline.rst
    A doc/apps/random.rst
    A doc/apps/translate.rst
    A doc/apps/view.rst
    M doc/compilation/index.rst
    A doc/compilation/vagrant.rst
    M doc/docs.rst
    R doc/stages/drivers.buffer.reader.rst
    R doc/stages/drivers.csar.reader.rst
    R doc/stages/drivers.faux.reader.rst
    R doc/stages/drivers.las.reader.rst
    R doc/stages/drivers.nitf.reader.rst
    R doc/stages/drivers.oci.reader.rst
    R doc/stages/drivers.pcd.reader.rst
    R doc/stages/drivers.pgpointcloud.reader.rst
    R doc/stages/drivers.qfit.reader.rst
    R doc/stages/drivers.sbet.reader.rst
    M doc/stages/index.rst
    M doc/tutorial/overview.rst
    R doc/vagrant.rst
    M include/pdal/drivers/buffer/BufferReader.hpp
    M include/pdal/drivers/caris/CloudReader.hpp
    M include/pdal/drivers/faux/Reader.hpp
    M include/pdal/drivers/las/Reader.hpp
    M include/pdal/drivers/nitf/Reader.hpp
    M include/pdal/drivers/oci/OciReader.hpp
    M include/pdal/drivers/pgpointcloud/PgReader.hpp
    M include/pdal/drivers/qfit/Reader.hpp
    M include/pdal/drivers/sbet/Reader.hpp
    M plugins/pcl/drivers/PcdReader.hpp

  Log Message:
  -----------
  Documentation update

Delete the individual stage docs in doc/stages. Move the documentation
to the corresponding header file, using \rst and \endrst tags in the
Doxygen. This should help us to 1) remember to create documentation for
our stages, and 2) remember to keep the documentation up-to-date.

Create dedicated "pages" to document the kernels, rather than having one
giant PDAL apps page.

Bounds class has been renamed to BOX3D, docs needed to be updated
accordingly.

No more Dimension or Schema refs in docs.

Add PointContext to docs.

Move Vagrant to the installation/compilation group.

Reader/Writer API pages need to include more of the actual
readers/writers.

Make the main Docs page more readable, as opposed to a big list.