Refactor: Update file comments.

src/bitstream.c

@@ -1,16 +1,14 @@
 /**
- *  HEVC Encoder
+ * \file
- *  - Marko Viitanen ( fador at iki.fi ), Tampere University of Technology, Department of Pervasive Computing.
+ * 
+ * \author Marko Viitanen ( fador@iki.fi ),
+ *         Tampere University of Technology,
+ *         Department of Pervasive Computing.
+ * \author Ari Koivula ( ari@koivu.la ),
+ *         Tampere University of Technology,
+ *         Department of Pervasive Computing.
  */
 
-/*! \file bitstream.c
-    \brief Bitstream related functions
-    \author Marko Viitanen
-    \date 2013-02
-    
-    This file has all bitstream functions
-*/
-
 #include "bitstream.h"
 
 #include <stdio.h>

src/bitstream.h

@@ -1,10 +1,15 @@
-/*! \file bitstream.h
+/**
-    \brief Bitstream related functions
+ * \file
-    \author Marko Viitanen
+ * \brief Bitstream can be written to one or several bits at a time.
-    \date 2012-05
+ * 
+ * \author Marko Viitanen ( fador@iki.fi ),
+ *         Tampere University of Technology,
+ *         Department of Pervasive Computing.
+ * \author Ari Koivula ( ari@koivu.la ),
+ *         Tampere University of Technology,
+ *         Department of Pervasive Computing.
+ */
 
-    This file has all bitstream headers
-*/
 #ifndef _BITSTREAM_H
 #define _BITSTREAM_H
  

src/cabac.c

@@ -1,16 +1,14 @@
 /**
- *  HEVC Encoder
+ * \file
- *  - Marko Viitanen ( fador at iki.fi ), Tampere University of Technology, Department of Pervasive Computing.
+ * 
+ * \author Marko Viitanen ( fador@iki.fi ), 
+ *         Tampere University of Technology,
+ *         Department of Pervasive Computing.
+ * \author Ari Koivula ( ari@koivu.la ), 
+ *         Tampere University of Technology,
+ *         Department of Pervasive Computing.
  */
 
-/*! \file cabac.c
-    \brief CABAC
-    \author Marko Viitanen
-    \date 2012-06
-    
-    Content-adaptive binary arithmetic coder
-*/
-
 #include "cabac.h"
 
 #include <stdlib.h>

src/cabac.h

@@ -1,15 +1,15 @@
 /**
- *  HEVC Encoder
+ * \file
- *  - Marko Viitanen ( fador at iki.fi ), Tampere University of Technology, Department of Pervasive Computing.
+ * \brief The Content Adaptive Binary Arithmetic Coder (CABAC).
+ * 
+ * \author Marko Viitanen ( fador@iki.fi ), 
+ *         Tampere University of Technology,
+ *         Department of Pervasive Computing.
+ * \author Ari Koivula ( ari@koivu.la ), 
+ *         Tampere University of Technology,
+ *         Department of Pervasive Computing.
  */
 
-/*! \file cabac.h
-    \brief CABAC
-    \author Marko Viitanen
-    \date 2012-06
-    
-    Content-adaptive binary arithmetic coder
-*/
 #ifndef __CABAC_H
 #define __CABAC_H
 

src/config.c

@@ -1,16 +1,14 @@
 /**
- *  HEVC Encoder
+ * \file
- *  - Marko Viitanen ( fador at iki.fi ), Tampere University of Technology, Department of Pervasive Computing.
+ * 
+ * \author Marko Viitanen ( fador@iki.fi ),
+ *         Tampere University of Technology,
+ *         Department of Pervasive Computing.
+ * \author Ari Koivula ( ari@koivu.la ),
+ *         Tampere University of Technology,
+ *         Department of Pervasive Computing.
  */
 
-/*! \file config.c
-    \brief Configuration related functions
-    \author Marko Viitanen
-    \date 2012-05
-    
-    This file has all configuration related functions
-*/
-
 #include "config.h"
 
 #include <stdio.h>

src/config.h

@@ -1,16 +1,15 @@
 /**
- *  HEVC Encoder
+ * \file
- *  - Marko Viitanen ( fador at iki.fi ), Tampere University of Technology, Department of Pervasive Computing.
+ * \brief Handles parsing and storing of configuration of the encoder.
+ * 
+ * \author Marko Viitanen ( fador@iki.fi ), 
+ *         Tampere University of Technology,
+ *         Department of Pervasive Computing.
+ * \author Ari Koivula ( ari@koivu.la ), 
+ *         Tampere University of Technology,
+ *         Department of Pervasive Computing.
  */
 
-/*! \file config.h
-    \brief Configuration header
-    \author Marko Viitanen
-    \date 2012-05
-    
-    Contains all configuration system related functions and structs
-*/
-
 #ifndef _CONFIG_H_
 #define _CONFIG_H_
 

src/context.c

@@ -1,15 +1,14 @@
 /**
- *  Part of HEVC Encoder
+ * \file
- *  By Marko Viitanen ( fador at iki.fi ), Tampere University of Technology, Department of Pervasive Computing.
+ * 
+ * \author Marko Viitanen ( fador@iki.fi ), 
+ *         Tampere University of Technology,
+ *         Department of Pervasive Computing.
+ * \author Ari Koivula ( ari@koivu.la ), 
+ *         Tampere University of Technology,
+ *         Department of Pervasive Computing.
  */
 
-/*! \file context.c
-    \brief Functions for context derication
-    \author Marko Viitanen
-    \date 2013-04    
-  This file contains context derivation functions
-*/
-
 #include "context.h"
 
 #include <stdio.h>

src/context.h

@@ -1,15 +1,15 @@
 /**
- *  HEVC Encoder
+ * \file
- *  - Marko Viitanen ( fador at iki.fi ), Tampere University of Technology, Department of Pervasive Computing.
+ * \brief Context derivation for CABAC.
+
+ * \author Marko Viitanen ( fador@iki.fi ), 
+ *         Tampere University of Technology,
+ *         Department of Pervasive Computing.
+ * \author Ari Koivula ( ari@koivu.la ), 
+ *         Tampere University of Technology,
+ *         Department of Pervasive Computing.
  */
 
-/*! \file context.h
-    \brief Context
-    \author Marko Viitanen
-    \date 2012-08
-    
-    Context derivation function headers
-*/
 #ifndef __CONTEXT_H
 #define __CONTEXT_H
 

src/debug.c

@@ -1,7 +1,12 @@
 /**
- * HEVC Encoder
+ * \file
- * - Marko Viitanen ( fador at iki.fi ), Tampere University of Technology, Department of Pervasive Computing 2013.
+ * 
- * - Ari Koivula (ari at koivu.la ), Tampere University of Technology, Department of Pervasive Computing 2013.
+ * \author Marko Viitanen ( fador@iki.fi ), 
+ *         Tampere University of Technology,
+ *         Department of Pervasive Computing.
+ * \author Ari Koivula ( ari@koivu.la ), 
+ *         Tampere University of Technology,
+ *         Department of Pervasive Computing.
  */
 
 #include "debug.h"

src/debug.h

@@ -1,7 +1,13 @@
 /**
- * HEVC Encoder
+ * \file
- * - Marko Viitanen ( fador at iki.fi ), Tampere University of Technology, Department of Pervasive Computing 2013.
+ * \brief Tools for visualizing and debugging the encoder.
- * - Ari Koivula (ari at koivu.la ), Tampere University of Technology, Department of Pervasive Computing 2013.
+ * 
+ * \author Marko Viitanen ( fador@iki.fi ), 
+ *         Tampere University of Technology,
+ *         Department of Pervasive Computing.
+ * \author Ari Koivula ( ari@koivu.la ), 
+ *         Tampere University of Technology,
+ *         Department of Pervasive Computing.
  */
 
 #ifndef __DEBUG_H

src/encmain.c

@@ -1,27 +1,15 @@
 /**
- *  HEVC Encoder
+ * \file
- *  - Marko Viitanen ( fador at iki.fi ), Tampere University of Technology, Department of Pervasive Computing.
+ * \brief User interface for the encoder.
- */
-
-/*! \file decmain.c
-    \brief main file for the Decoder
-    \author Marko Viitanen
-    \date 2012-05
-    
-    This file contains main() function
-*/
-
-/*! \mainpage HEVC Encoder
  * 
- * \section Coding style
+ * \author Marko Viitanen ( fador@iki.fi ), 
- *
+ *         Tampere University of Technology,
- * Coding style is explained in it's own document.
+ *         Department of Pervasive Computing.
- *
+ * \author Ari Koivula ( ari@koivu.la ), 
- * \section usage_sec Usage
+ *         Tampere University of Technology,
- *
+ *         Department of Pervasive Computing.
- * \subsection encode_subsec Basic Decoding:
- * Use encmain.exe -i input.yuv -o output.hevc
  *
+ * TODO: Check that these usage instructions are correct.
  * \subsection options_subsec All program options:
  *            - -i <filename>: input
  *            - -o <filename>: output

src/encoder.c

@@ -1,16 +1,14 @@
 /**
- *  HEVC Encoder
+ * \file
- *  - Marko Viitanen ( fador at iki.fi ), Tampere University of Technology, Department of Pervasive Computing.
+ * 
+ * \author Marko Viitanen ( fador@iki.fi ), 
+ *         Tampere University of Technology,
+ *         Department of Pervasive Computing.
+ * \author Ari Koivula ( ari@koivu.la ), 
+ *         Tampere University of Technology,
+ *         Department of Pervasive Computing.
  */
 
-/*! \file encoder.c
-    \brief Encoding related functions
-    \author Marko Viitanen
-    \date 2013-03
-    
-    Encoder main level
-*/
-/* Suppress some visual studio warnings */
 #ifdef WIN32
   #define _CRT_SECURE_NO_WARNINGS
 #endif

src/encoder.h

@@ -1,15 +1,15 @@
 /**
- *  HEVC Encoder
+ * \file
- *  - Marko Viitanen ( fador at iki.fi ), Tampere University of Technology, Department of Pervasive Computing.
+ * \brief The highest level of the encoder.
+ * 
+ * \author Marko Viitanen ( fador@iki.fi ), 
+ *         Tampere University of Technology,
+ *         Department of Pervasive Computing.
+ * \author Ari Koivula ( ari@koivu.la ), 
+ *         Tampere University of Technology,
+ *         Department of Pervasive Computing.
  */
 
-/*! \file encoder.h
-    \brief Encoding related functions
-    \author Marko Viitanen
-    \date 2012-06
-    
-    Structures for encoding
-*/
 #ifndef __ENCODER_H
 #define __ENCODER_H
 

src/filter.c

@@ -1,16 +1,14 @@
 /**
- *  HEVC Encoder
+ * \file
- *  - Marko Viitanen ( fador at iki.fi ), Tampere University of Technology, Department of Pervasive Computing.
+ * 
+ * \author Marko Viitanen ( fador@iki.fi ), 
+ *         Tampere University of Technology,
+ *         Department of Pervasive Computing.
+ * \author Ari Koivula ( ari@koivu.la ), 
+ *         Tampere University of Technology,
+ *         Department of Pervasive Computing.
  */
 
-/*! \file filter.c
-    \brief filtering
-    \author Marko Viitanen
-    \date 2013-05
-    
-    Filtering functions
-*/
-
 #include "filter.h"
 
 #include <stdio.h>

src/filter.h

@@ -1,15 +1,15 @@
 /**
- *  HEVC Encoder
+ * \file
- *  - Marko Viitanen ( fador at iki.fi ), Tampere University of Technology, Department of Pervasive Computing 2013.
+ * \brief Filtering, such as deblocking.
+ * 
+ * \author Marko Viitanen ( fador@iki.fi ), 
+ *         Tampere University of Technology,
+ *         Department of Pervasive Computing.
+ * \author Ari Koivula ( ari@koivu.la ), 
+ *         Tampere University of Technology,
+ *         Department of Pervasive Computing.
  */
 
-/*! \file filter.h
-    \brief filter
-    \author Marko Viitanen
-    \date 2013-05
-    
-    Filtering function headers
-*/
 #ifndef __FILTER_H
 #define __FILTER_H
 

src/global.h

@@ -1,15 +1,19 @@
 /**
- *  HEVC Encoder
+ * \file
- *  - Marko Viitanen ( fador at iki.fi ), Tampere University of Technology, Department of Pervasive Computing.
+ * \brief Header that is included in every other header.
+ * 
+ * \author Marko Viitanen ( fador@iki.fi ), 
+ *         Tampere University of Technology,
+ *         Department of Pervasive Computing.
+ * \author Ari Koivula ( ari@koivu.la ), 
+ *         Tampere University of Technology,
+ *         Department of Pervasive Computing.
+ * 
+ * This file contains global constants that can be referred to from any header
+ * or source file. It also contains some helper macros and includes stdint.h
+ * so that any file can refer to integer types with exact widths.
  */
 
-/*! \file global.h
-    \brief Contains global includes
-    \author Marko Viitanen
-    \date 2013-06
-  
-    This file should be included in every C-file.
-*/
 #ifndef __GLOBAL_H
 #define __GLOBAL_H
 

src/inter.c

@@ -1,16 +1,14 @@
 /**
- *  HEVC Encoder
+ * \file
- *  - Marko Viitanen ( fador at iki.fi ), Tampere University of Technology, Department of Pervasive Computing.
+ * 
+ * \author Marko Viitanen ( fador@iki.fi ), 
+ *         Tampere University of Technology,
+ *         Department of Pervasive Computing.
+ * \author Ari Koivula ( ari@koivu.la ), 
+ *         Tampere University of Technology,
+ *         Department of Pervasive Computing.
  */
 
-/*! \file inter.c
-    \brief Inter functions
-    \author Marko Viitanen
-    \date 2013-04
-    
-    Inter functions
-*/
-
 #include "inter.h"
 
 #include <stdio.h>

src/inter.h

@@ -1,15 +1,15 @@
 /**
- *  HEVC Encoder
+ * \file
- *  - Marko Viitanen ( fador at iki.fi ), Tampere University of Technology, Department of Pervasive Computing.
+ * \brief Handling Coding Units (CU's) for inter frames.
+ * 
+ * \author Marko Viitanen ( fador@iki.fi ), 
+ *         Tampere University of Technology,
+ *         Department of Pervasive Computing.
+ * \author Ari Koivula ( ari@koivu.la ), 
+ *         Tampere University of Technology,
+ *         Department of Pervasive Computing.
  */
 
-/*! \file inter.h
-    \brief Inter function headers
-    \author Marko Viitanen
-    \date 2013-04
-    
-    Inter functions
-*/
 #ifndef __INTER_H
 #define __INTER_H
 

src/intra.c

@@ -1,15 +1,15 @@
 /**
- *  HEVC Encoder
+ * \file
- *  - Marko Viitanen ( fador at iki.fi ), Tampere University of Technology, Department of Pervasive Computing.
+ * \brief Functions for handling intra frames.
+ * 
+ * \author Marko Viitanen ( fador@iki.fi ), 
+ *         Tampere University of Technology,
+ *         Department of Pervasive Computing.
+ * \author Ari Koivula ( ari@koivu.la ), 
+ *         Tampere University of Technology,
+ *         Department of Pervasive Computing.
  */
 
-/*! \file intra.c
-    \brief Intra functions
-    \author Marko Viitanen
-    \date 2013-03
-    
-    Intra functions
-*/
 
 #include "intra.h"
 

src/intra.h

@@ -1,15 +1,15 @@
 /**
- *  HEVC Encoder
+ * \file
- *  - Marko Viitanen ( fador at iki.fi ), Tampere University of Technology, Department of Pervasive Computing.
+ * \brief Handling Coding Units (CU's) for intra frames.
+ * 
+ * \author Marko Viitanen ( fador@iki.fi ), 
+ *         Tampere University of Technology,
+ *         Department of Pervasive Computing.
+ * \author Ari Koivula ( ari@koivu.la ), 
+ *         Tampere University of Technology,
+ *         Department of Pervasive Computing.
  */
 
-/*! \file intra.h
-    \brief Intra function headers
-    \author Marko Viitanen
-    \date 2013-03
-    
-    Intra functions
-*/
 #ifndef __INTRA_H
 #define __INTRA_H
 

src/nal.c

@@ -1,16 +1,14 @@
 /**
- *  HEVC Encoder
+ * \file
- *  - Marko Viitanen ( fador at iki.fi ), Tampere University of Technology, Department of Pervasive Computing.
+ * 
+ * \author Marko Viitanen ( fador@iki.fi ), 
+ *         Tampere University of Technology,
+ *         Department of Pervasive Computing.
+ * \author Ari Koivula ( ari@koivu.la ), 
+ *         Tampere University of Technology,
+ *         Department of Pervasive Computing.
  */
 
-/*! \file nal.c
-    \brief NAL
-    \author Marko Viitanen
-    \date 2013-06
-    
-    NAL functions
-*/
-
 #include "nal.h"
 
 #include <stdlib.h>

src/nal.h

@@ -1,15 +1,15 @@
 /**
- *  HEVC Encoder
+ * \file
- *  - Marko Viitanen ( fador at iki.fi ), Tampere University of Technology, Department of Pervasive Computing 2013.
+ * \brief Network Abstraction Layer (NAL) messages.
+ * 
+ * \author Marko Viitanen ( fador@iki.fi ), 
+ *         Tampere University of Technology,
+ *         Department of Pervasive Computing.
+ * \author Ari Koivula ( ari@koivu.la ), 
+ *         Tampere University of Technology,
+ *         Department of Pervasive Computing.
  */
 
-/*! \file nal.h
-    \brief NAL
-    \author Marko Viitanen
-    \date 2013-02
-    
-    NAL function headers
-*/
 #ifndef __NAL_H
 #define __NAL_H
 

src/picture.c

@@ -1,17 +1,14 @@
 /**
- *  Part of HEVC Encoder
+ * \file
- *  By Marko Viitanen ( fador at iki.fi ), Tampere University of Technology, Department of Pervasive Computing.
+ * 
+ * \author Marko Viitanen ( fador@iki.fi ), 
+ *         Tampere University of Technology,
+ *         Department of Pervasive Computing.
+ * \author Ari Koivula ( ari@koivu.la ), 
+ *         Tampere University of Technology,
+ *         Department of Pervasive Computing.
  */
 
-/*! \file picture.c
-    \brief Functions to handle pictures
-    \author Marko Viitanen
-    \date 2013-06
-    
-  This file contains all the needed functions to handle pictures
-
-*/
-
 #include "picture.h"
 
 #include <string.h>

src/picture.h

@@ -1,16 +1,15 @@
 /**
- *  Part of HEVC Encoder
+ * \file
- *  By Marko Viitanen ( fador at iki.fi ), Tampere University of Technology, Department of Pervasive Computing.
+ * \brief Coding Unit (CU) and picture data related functions.
+ * 
+ * \author Marko Viitanen ( fador@iki.fi ), 
+ *         Tampere University of Technology,
+ *         Department of Pervasive Computing.
+ * \author Ari Koivula ( ari@koivu.la ), 
+ *         Tampere University of Technology,
+ *         Department of Pervasive Computing.
  */
 
-/*! \file picture.h
-    \brief Picture header
-    \author Marko Viitanen
-    \date 2013-04
-    
-    Contains all picture related functions and structs
-*/
-
 #ifndef _PICTURE_H_
 #define _PICTURE_H_
 

src/search.c

@@ -1,16 +1,14 @@
 /**
- *  HEVC Encoder
+ * \file
- *  - Marko Viitanen ( fador at iki.fi ), Tampere University of Technology, Department of Pervasive Computing.
+ * 
+ * \author Marko Viitanen ( fador@iki.fi ), 
+ *         Tampere University of Technology,
+ *         Department of Pervasive Computing.
+ * \author Ari Koivula ( ari@koivu.la ), 
+ *         Tampere University of Technology,
+ *         Department of Pervasive Computing.
  */
 
-/*! \file search.c
-    \brief searching
-    \author Marko Viitanen
-    \date 2013-04
-    
-    Search related functions
-*/
-
 #include "search.h"
 
 #include <stdio.h>

src/search.h

@@ -1,16 +1,15 @@
 /**
- *  HEVC Encoder
+ * \file
- *  - Marko Viitanen ( fador at iki.fi ), Tampere University of Technology, Department of Pervasive Computing 2013.
+ * \brief Searching of parameters for intra and inter frames.
+ * 
+ * \author Marko Viitanen ( fador@iki.fi ), 
+ *         Tampere University of Technology,
+ *         Department of Pervasive Computing.
+ * \author Ari Koivula ( ari@koivu.la ), 
+ *         Tampere University of Technology,
+ *         Department of Pervasive Computing.
  */
 
-/*! \file search.h
-    \brief searching
-    \author Marko Viitanen
-    \date 2013-04
-    
-    Search related function headers
-*/
-
 #ifndef __SEARCH_H
 #define __SEARCH_H
 

src/transform.c

@@ -1,15 +1,14 @@
 /**
- *  HEVC Encoder
+ * \file
- *  - Marko Viitanen ( fador at iki.fi ), Tampere University of Technology, Department of Pervasive Computing.
+ * 
+ * \author Marko Viitanen ( fador@iki.fi ), 
+ *         Tampere University of Technology,
+ *         Department of Pervasive Computing.
+ * \author Ari Koivula ( ari@koivu.la ), 
+ *         Tampere University of Technology,
+ *         Department of Pervasive Computing.
  */
 
-/*! \file transform.c
-    \brief Transform functions
-    \author Marko Viitanen
-    \date 2012-09
-    
-    Transform functions
-*/
 #include "transform.h"
 
 #include <string.h>

src/transform.h

@@ -1,15 +1,15 @@
 /**
- *  HEVC Encoder
+ * \file
- *  - Marko Viitanen ( fador at iki.fi ), Tampere University of Technology, Department of Pervasive Computing.
+ * \brief Transformations, such as quantization and DST.
+ * 
+ * \author Marko Viitanen ( fador@iki.fi ), 
+ *         Tampere University of Technology,
+ *         Department of Pervasive Computing.
+ * \author Ari Koivula ( ari@koivu.la ), 
+ *         Tampere University of Technology,
+ *         Department of Pervasive Computing.
  */
 
-/*! \file transform.h
-    \brief Transform functions
-    \author Marko Viitanen
-    \date 2012-09
-    
-    Transform functions
-*/
 #ifndef __TRANSFORM_H
 #define __TRANSFORM_H