doc_gather.c File Reference

Just a place to force the documentation. More...

#include <stdio.h>
#include <PBI/Attribute.h>
#include <PBI/Alias.h>
#include <PBI/Endianness.h>
#include <PBI/Inline.h>
#include <PBI/Ofs.h>
#include <PBI/Unions.h>
#include <PBI/TBD_id.h>
#include <PBI/Fletcher.h>

Functions
int	main (int argc, char **argv)
	This routine does nothing. doc is not a real program, it just serves to act as a gathering place for all the includes that contribute to PBI's documentation.
int	doc_gather (void)
	This routine does nothing. doc is not a real program, it just serves to act as a gathering place for all the includes that contribute to PBI's documentation.

---

Detailed Description

Just a place to force the documentation.

Author:

JJRussell - russell@slac.stanford.edu

   CVS $Id: doc_gather.c,v 1.6 2011/03/24 20:50:58 apw Exp $
  

This program does nothing. doc-gather is, in fact, not a real program, it just serves to act as a gathering place for all the includes that contribute to PBI's documentation.

Just on the principle of least surprise, one can run it, but all it does is print a similar sounding explanation message and return success. This is provided just in case one automates the running of test procedures.

---

Function Documentation

int main	(	int	argc,
		char **	argv
	)

This routine does nothing. doc is not a real program, it just serves to act as a gathering place for all the includes that contribute to PBI's documentation.

Return values:

0,always

This program takes no arguments.

References doc_gather().