Skip to content

Commit

Permalink
Merge pull request #156 from gadomski/doc-fix
Browse files Browse the repository at this point in the history
Remove note about pdal.hpp from docs — DNE
  • Loading branch information
hobu committed Jul 7, 2013
2 parents 2d4e16a + d81cf5c commit 947b039
Showing 1 changed file with 2 additions and 6 deletions.
8 changes: 2 additions & 6 deletions doc/development/conventions.txt
Expand Up @@ -106,14 +106,10 @@ Layout/Organization of Source Tree
pdal headers may be further grouped by subdirectory, e.g. drivers/liblas,
filters, etc.

* First exception to the above: source files (.cpp) should #include their
* Exception to the above: source files (.cpp) should #include their
corresponding .hpp file first. This assures that the header is including
all the files it needs to.

* Second exception to the above: header files (.hpp) should #include pdal.hpp
first. This assures that we are consistent in including all "standard" stuff
we use everywhere.

* Don't #include a file where a simple forward declaration will do.
(Note: this only applies to pdal files; don't forward declare from system
or 3rd party headers.)
Expand All @@ -122,4 +118,4 @@ Layout/Organization of Source Tree

* Include guards should spell out the full path, like this:
#ifndef INCLUDED_DRIVERS_FAUX_READER_ITERATOR_HPP


0 comments on commit 947b039

Please sign in to comment.