Indicating Include Files

PreviousUpNext
Up: Structured Comments Next: Command Line Arguments Previous: Indicating Special Limitations

It is often very important to indicate which include files need to be used with a particular routine. For this purpose, you may add a special structured comment of the form /*I include-file-nameI*/. For example, to indicate that the routine requires that <sys/time.h> has been included, use

 
#include <sys/time.h>          /*I <sys/time.h> I*/ 
in the C file. A user-include can be specified as
 
#include "system/nreg.h"      /*I "system/nreg.h" I*/ 
This approach of putting the structured include comment on the same line as the include of the file ensures that if the source file is changed by removing the include, the documentation and Fortran wrappers will reflect that change.


PreviousUpNext
Up: Structured Comments Next: Command Line Arguments Previous: Indicating Special Limitations