psyc-mirrors
/
libpsyc
mirror of git://git.psyc.eu/libpsyc
1
0
Fork 0
Code Issues Releases Wiki Activity

added doxygen file documentation

This commit is contained in:
Mathias Laurenz Baumann 2011-04-19 22:27:38 +02:00
parent 2b9190b8c0
commit 5240637577
2 changed files with 12 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
Doxyfile
View File

@ -612,7 +612,8 @@ WARN_LOGFILE =
# directories like "/usr/src/myproject". Separate the files or directories # directories like "/usr/src/myproject". Separate the files or directories
# with spaces. # with spaces.
INPUT = src include INPUT = src \
include
# This tag can be used to specify the character encoding of the source files # 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 # 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 # doxygen to hide any special comment blocks from generated source code
# fragments. Normal C and C++ comments will always remain visible. # 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 # If the REFERENCED_BY_RELATION tag is set to YES
# then for each documented function all documented # then for each documented function all documented

8
include/psyc/parser.h
View File

@ -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 #ifndef PSYC_PARSER_H
# define PSYC_PARSER_H # define PSYC_PARSER_H