Commit ae833884 authored by conrad's avatar conrad

add missing file descriptions to headers


git-svn-id: http://svn.annodex.net/liboggz/trunk@825 8158c8cd-e7e1-0310-9fa4-c5954c97daef
parent abfe5237
......@@ -33,6 +33,10 @@
#ifndef __OGGZ_DEPRECATED_H__
#define __OGGZ_DEPRECATED_H__
/** \file
* Deprecated interfaces
*/
/**
* DEPRECATED CONSTANT.
* OGGZ_ERR_USER_STOPPED was introduced during development (post 0.8.3),
......
......@@ -33,6 +33,10 @@
#ifndef __OGGZ_READ_H__
#define __OGGZ_READ_H__
/** \file
* Interfaces for reading Ogg files and streams
*/
/** \defgroup read_api OGGZ Read API
*
* OGGZ parses Ogg bitstreams, forming ogg_packet structures, and calling
......
......@@ -33,6 +33,9 @@
#ifndef __OGGZ_SEEK_H__
#define __OGGZ_SEEK_H__
/** \file
* Seeking within files
*/
/** \defgroup auto OGGZ_AUTO
*
......
......@@ -33,6 +33,10 @@
#ifndef __OGGZ_WRITE_H__
#define __OGGZ_WRITE_H__
/** \file
* Interfaces for writing Ogg files and streams
*/
/** \defgroup force_feed Writing by force feeding OGGZ
*
* Force feeding involves synchronously:
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment