mainpage.h 3.07 KB
Newer Older
Alberto Gonzalez's avatar
Alberto Gonzalez committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65
#include "TLibCommon/CommonDef.h"

/**
 * \file mainpage.h
 * \brief HEVC reference documentation main page (no functional use)
 * \mainpage
 *
 * \section Introduction
 *
 *  This is the doxygen generated documentation of the HEVC HM reference software.
 *
 *  For detailed information see the sub-pages of this site.
 *
 *  For information on the <b>subversion repositories</b> and the <b>software manual</b> see
 *  http://hevc.hhi.fraunhofer.de
 *
 *  For <b>bug reporting and known issues</b> see:
 *  https://hevc.hhi.fraunhofer.de/trac/hevc
 *
 * \section License
 *
 * The copyright in this software is being made available under the BSD
 * License, included below. This software may be subject to other third party
 * and contributor rights, including patent rights, and no such rights are
 * granted under this license.
 *
 * Copyright (c) 2010-2023, ITU/ISO/IEC
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 *  - Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 *  - Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 *  - Neither the name of the ITU/ISO/IEC nor the names of its contributors may
 *    be used to endorse or promote products derived from this software without
 *    specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS
 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
 * THE POSSIBILITY OF SUCH DAMAGE.
 *
 *  \note
 *     This document is automatically generated from the source code and special documentation tags.
 *     For more details on the used documentation system see http://www.doxygen.org
 *
 *  \defgroup TLibCommon   TLibCommon  - Library containing functionality that is shared between encoder and decoder
 *  \defgroup TLibEncoder  TLibEncoder - Library containing encoder functionality
 *  \defgroup TLibDecoder  TLibDecoder - Library containing encoder functionality
 *  \defgroup libMD5       libMD5      - MD5 helper functions
 *  \defgroup TAppCommon   TAppCommon  - Application support library
 *  \defgroup TAppEncoder  TAppEncoder - Encoder application
 *  \defgroup TAppDecoder  TAppDecoder - Decoder application
 */