From 52406375775658f71afdfd5c8eca15a3549accf0 Mon Sep 17 00:00:00 2001 From: Mathias Laurenz Baumann Date: Tue, 19 Apr 2011 22:27:38 +0200 Subject: [PATCH] added doxygen file documentation --- Doxyfile | 7 ++++--- include/psyc/parser.h | 8 ++++++++ 2 files changed, 12 insertions(+), 3 deletions(-) diff --git a/Doxyfile b/Doxyfile index 882cc8a..4f868f6 100644 --- a/Doxyfile +++ b/Doxyfile @@ -321,7 +321,7 @@ SYMBOL_CACHE_SIZE = 0 # Private class members and static file members will be hidden unless # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES -EXTRACT_ALL = YES +EXTRACT_ALL = YES # If the EXTRACT_PRIVATE tag is set to YES all private members of a class # will be included in the documentation. @@ -612,7 +612,8 @@ WARN_LOGFILE = # directories like "/usr/src/myproject". Separate the files or directories # with spaces. -INPUT = src include +INPUT = src \ + include # This tag can be used to specify the character encoding of the source files # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is @@ -776,7 +777,7 @@ INLINE_SOURCES = NO # doxygen to hide any special comment blocks from generated source code # fragments. Normal C and C++ comments will always remain visible. -STRIP_CODE_COMMENTS = YES +STRIP_CODE_COMMENTS = NO # If the REFERENCED_BY_RELATION tag is set to YES # then for each documented function all documented diff --git a/include/psyc/parser.h b/include/psyc/parser.h index 1b739a5..8d14397 100644 --- a/include/psyc/parser.h +++ b/include/psyc/parser.h @@ -1,3 +1,11 @@ +/** + * @file psyc/parser.h + * @brief Interface for various psyc parser functions + * + * All parsing functions and the definitions they use are + * defined in this file. +*/ + #ifndef PSYC_PARSER_H # define PSYC_PARSER_H