Misc documentation fixes. Change `-ise' to `-ize' throughout.

[mLib] / tv.h

/* -*-c-*-
 *
 * $Id: tv.h,v 1.3 1999/05/06 19:51:36 mdw Exp $
 *
 * Manipulation of timeval structures
 *
 * (c) 1998 Straylight/Edgeware
 */

/*----- Licensing notice --------------------------------------------------* 
 *
 * This file is part of the mLib utilities library.
 *
 * mLib is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Library General Public License as
 * published by the Free Software Foundation; either version 2 of the
 * License, or (at your option) any later version.
 * 
 * mLib is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Library General Public License for more details.
 * 
 * You should have received a copy of the GNU Library General Public
 * License along with mLib; if not, write to the Free
 * Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
 * MA 02111-1307, USA.
 */

/*----- Revision history --------------------------------------------------* 
 *
 * $Log: tv.h,v $
 * Revision 1.3  1999/05/06 19:51:36  mdw
 * Reformatted the LGPL notice a little bit.
 *
 * Revision 1.2  1999/05/05 18:50:31  mdw
 * Change licensing conditions to LGPL.
 *
 * Revision 1.1  1998/11/25 23:30:01  mdw
 * New file.
 *
 */

#ifndef TV_H
#define TV_H

#ifdef __cplusplus
  extern "C" {
#endif

/*----- Header files ------------------------------------------------------*/

#include <sys/time.h>

/*----- Functions provided ------------------------------------------------*/

/* --- @tv_add@ --- *
 *
 * Arguments:	@struct timeval *dst@ = destination block
 *		@const struct timeval *a, *b@ = source blocks
 *
 * Returns:	---
 *
 * Use:		Adds two timevals.
 */

extern void tv_add(struct timeval */*dst*/,
		   const struct timeval */*a*/,
		   const struct timeval */*b*/);

/* --- @tv_sub@ --- *
 *
 * Arguments:	@struct timeval *dst@ = destination block
 *		@const struct timeval *a, *b@ = source blocks
 *
 * Returns:	---
 *
 * Use:		Subtracts two timevals.
 */

extern void tv_sub(struct timeval */*dst*/,
		   const struct timeval */*a*/,
		   const struct timeval */*b*/);

/* --- @tv_cmp@ --- *
 *
 * Arguments:	@const struct timeval *a, *b@ = source blocks
 *
 * Returns:	Less than, equal to, or greater than zero.
 *
 * Use:		Compares two timevals.
 */

extern int tv_cmp(const struct timeval */*a*/,
		  const struct timeval */*b*/);

/*----- That's all, folks -------------------------------------------------*/

#ifdef __cplusplus
  }
#endif

#endif