Changeset 21ae4b9 for lib/format_erf.h


Ignore:
Timestamp:
02/05/10 16:24:54 (12 years ago)
Author:
Shane Alcock <salcock@…>
Branches:
4.0.1-hotfixes, cachetimestamps, develop, dpdk-ndag, etsilive, getfragoff, help, libtrace4, master, ndag_format, pfring, rc-4.0.1, rc-4.0.2, rc-4.0.3, rc-4.0.4, ringdecrementfix, ringperformance, ringtimestampfixes
Children:
c0fcc14
Parents:
0bb3004
Message:
  • Added doxygen documentation to a couple more header files
File:
1 edited

Legend:

Unmodified
Added
Removed
  • lib/format_erf.h

    r5e85c23 r21ae4b9  
     1/*
     2 * This file is part of libtrace
     3 *
     4 * Copyright (c) 2007,2008,2009,2010 The University of Waikato, Hamilton,
     5 * New Zealand.
     6 *
     7 * Authors: Daniel Lawson
     8 *          Perry Lorier
     9 *          Shane Alcock
     10 *         
     11 * All rights reserved.
     12 *
     13 * This code has been developed by the University of Waikato WAND
     14 * research group. For further information please see http://www.wand.net.nz/
     15 *
     16 * libtrace is free software; you can redistribute it and/or modify
     17 * it under the terms of the GNU General Public License as published by
     18 * the Free Software Foundation; either version 2 of the License, or
     19 * (at your option) any later version.
     20 *
     21 * libtrace is distributed in the hope that it will be useful,
     22 * but WITHOUT ANY WARRANTY; without even the implied warranty of
     23 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
     24 * GNU General Public License for more details.
     25 *
     26 * You should have received a copy of the GNU General Public License
     27 * along with libtrace; if not, write to the Free Software
     28 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
     29 *
     30 * $Id: libtrace.h.in 1503 2010-02-02 22:23:43Z salcock $
     31 *
     32 */
     33
    134#ifndef FORMAT_ERF_H
    235#define FORMAT_ERF_H
    336
    437#include "libtrace.h"
     38
     39/** @file
     40 *
     41 * @brief Header file defining functions that apply to all libtrace formats
     42 * that use the ERF record format, e.g. ERF, DAG 2.4, DAG 2.5
     43 *
     44 * @author Daniel Lawson
     45 * @author Perry Lorier
     46 * @author Shane Alcock
     47 *
     48 * @version $Id$
     49 *
     50 * Not too much detail required with these functions - this header file exists
     51 * solely to ensure that we don't have to duplicate the same code across
     52 * multiple format modules.
     53 */
    554
    655int erf_get_framing_length(const libtrace_packet_t *packet);
Note: See TracChangeset for help on using the changeset viewer.