Header usage

This document defines how headers of the Astrog library should be written, and how they should be included in files internal to the library. For how to include the headers in programs that want to link to the library, see the user header documentation.

Internal Astrog header information

The Astrog library header file convention is as follows. Each source file has a single associated header file that it includes. This header file then includes all other headers needed by the source. This must have the general Astrog header file, libastrog_astrog.h, the general header for that subdirectory, and the header files of any other Astrog library objects it requires.

The naming convention for the header files is as follows:

For source file: FILENAME.cpp

Use header file: libastrog_FILENAME.h

See the source file conventions for how you should name FILENAME, and where to locate your source and header files in the tree. The header file location in the inc tree should match the location of the source file in the src tree.

The libastrog.h header should include all pipeline headers. As new pipelines are created they should be added to this file.

The filenames of headers should be listed in the Makefile.am file in the same directory.

---