From 400a9fab2e77b3a89819e642233cef53b83ccb0f Mon Sep 17 00:00:00 2001 From: albeu Date: Tue, 25 Apr 2006 01:26:10 +0000 Subject: Doxygen Attack! - Chapter 3 git-svn-id: svn://svn.mplayerhq.hu/mplayer/trunk@18266 b3059339-0415-0410-9bf9-f77b7e298cf2 --- parser-cfg.c | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) (limited to 'parser-cfg.c') diff --git a/parser-cfg.c b/parser-cfg.c index 529580caf9..c792ced3ac 100644 --- a/parser-cfg.c +++ b/parser-cfg.c @@ -1,3 +1,12 @@ + +/// \defgroup ConfigParsers Config parsers +/// +/// The \ref ConfigParsers make use of the \ref Config to setup the config variables, +/// the command line parsers also build the playlist. +///@{ + +/// \file + #include "config.h" #include @@ -14,10 +23,17 @@ #include "m_option.h" #include "m_config.h" +/// Maximal include depth. #define MAX_RECURSION_DEPTH 8 +/// Current include depth. static int recursion_depth = 0; +/// Setup the \ref Config from a config file. +/** \param config The config object. + * \param conffile Path to the config file. + * \return 1 on sucess, -1 on error. + */ int m_config_parse_config_file(m_config_t* config, char *conffile) { #define PRINT_LINENUM mp_msg(MSGT_CFGPARSER,MSGL_V,"%s(%d): ", conffile, line_num) @@ -226,3 +242,5 @@ out: --recursion_depth; return ret; } + +///@} -- cgit v1.2.3