mirror of
https://github.com/ultravideo/uvg266.git
synced 2024-11-24 10:34:05 +00:00
947bae24f9
Add module information to all header files. Update all header file documentations to briefly say what they are, and to use the javadoc format so the brief actually gets included into the doxygen documentation. Remove \file from implementation files, in order to not repeat the info from the header files. Add files under strategies and tools to Doxygen and update the Doxygen settings to be just plain better. Make README be the main page of Doxygen documentation.
42 lines
1.4 KiB
C
42 lines
1.4 KiB
C
#ifndef ENCODER_STATE_CTORS_DTORS_H_
|
|
#define ENCODER_STATE_CTORS_DTORS_H_
|
|
/*****************************************************************************
|
|
* This file is part of Kvazaar HEVC encoder.
|
|
*
|
|
* Copyright (C) 2013-2015 Tampere University of Technology and others (see
|
|
* COPYING file).
|
|
*
|
|
* Kvazaar is free software: you can redistribute it and/or modify it under
|
|
* the terms of the GNU Lesser General Public License as published by the
|
|
* Free Software Foundation; either version 2.1 of the License, or (at your
|
|
* option) any later version.
|
|
*
|
|
* Kvazaar 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 Lesser General Public License for
|
|
* more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License along
|
|
* with Kvazaar. If not, see <http://www.gnu.org/licenses/>.
|
|
****************************************************************************/
|
|
|
|
/**
|
|
* \ingroup Control
|
|
* \file
|
|
* Creation and destruction of encoder_state_t.
|
|
*/
|
|
|
|
#include "global.h"
|
|
|
|
|
|
// Forward declare because including the header would lead to a cyclic
|
|
// dependency.
|
|
struct encoder_state_t;
|
|
|
|
|
|
int kvz_encoder_state_init(struct encoder_state_t * child_state, struct encoder_state_t * parent_state);
|
|
void kvz_encoder_state_finalize(struct encoder_state_t *state);
|
|
|
|
|
|
#endif // ENCODER_STATE_CTORS_DTORS_H_
|