PTS_comdefs.h File Reference

Processor Timer Services, common definitions and documentation. More...

Detailed Description

Processor Timer Services, common definitions and documentation.

Author:: JJRussell - russell@slac.stanford.edu


     CVS $Id: PTS_comdefs.h,v 1.3 2005/10/01 01:00:12 russell Exp $

This file because it was the only way I could figure out how to keep DOXYGEN happy. It properly belongs in PTS.h, but PTS.h also includes function prototypes, that in some cases are not needed. Since DOXYGEN does not fully understand preprocessor symbols, there was no way to #ifdef away the prototypes when they were not needed. The only two alternatives I saw was copying the documentation into every file where it was needed or breaking out this file. Neither was a great solution.