diff --git a/.doxygen b/.doxygen deleted file mode 100644 index 7d07de8..0000000 --- a/.doxygen +++ /dev/null @@ -1,277 +0,0 @@ -# Doxyfile 1.7.3 - -#--------------------------------------------------------------------------- -# Project related configuration options -#--------------------------------------------------------------------------- -DOXYFILE_ENCODING = UTF-8 -PROJECT_NAME = Server -PROJECT_NUMBER = 0.0.1 -PROJECT_BRIEF = "HTTP/REST server implementation" -PROJECT_LOGO = -OUTPUT_DIRECTORY = docs -CREATE_SUBDIRS = NO -OUTPUT_LANGUAGE = English -BRIEF_MEMBER_DESC = YES -REPEAT_BRIEF = YES -ABBREVIATE_BRIEF = -ALWAYS_DETAILED_SEC = NO -INLINE_INHERITED_MEMB = NO -FULL_PATH_NAMES = YES -STRIP_FROM_PATH = -STRIP_FROM_INC_PATH = -SHORT_NAMES = NO -JAVADOC_AUTOBRIEF = NO -QT_AUTOBRIEF = NO -MULTILINE_CPP_IS_BRIEF = NO -INHERIT_DOCS = YES -SEPARATE_MEMBER_PAGES = NO -TAB_SIZE = 8 -ALIASES = -OPTIMIZE_OUTPUT_FOR_C = YES -OPTIMIZE_OUTPUT_JAVA = NO -OPTIMIZE_FOR_FORTRAN = NO -OPTIMIZE_OUTPUT_VHDL = NO -EXTENSION_MAPPING = -BUILTIN_STL_SUPPORT = NO -CPP_CLI_SUPPORT = YES -SIP_SUPPORT = NO -IDL_PROPERTY_SUPPORT = YES -DISTRIBUTE_GROUP_DOC = NO -SUBGROUPING = YES -TYPEDEF_HIDES_STRUCT = NO -SYMBOL_CACHE_SIZE = 0 -#--------------------------------------------------------------------------- -# Build related configuration options -#--------------------------------------------------------------------------- -EXTRACT_ALL = YES -EXTRACT_PRIVATE = NO -EXTRACT_STATIC = NO -EXTRACT_LOCAL_CLASSES = YES -EXTRACT_LOCAL_METHODS = YES -EXTRACT_ANON_NSPACES = YES -HIDE_UNDOC_MEMBERS = NO -HIDE_UNDOC_CLASSES = NO -HIDE_FRIEND_COMPOUNDS = NO -HIDE_IN_BODY_DOCS = NO -INTERNAL_DOCS = YES -CASE_SENSE_NAMES = YES -HIDE_SCOPE_NAMES = NO -SHOW_INCLUDE_FILES = YES -FORCE_LOCAL_INCLUDES = NO -INLINE_INFO = YES -SORT_MEMBER_DOCS = YES -SORT_BRIEF_DOCS = NO -SORT_MEMBERS_CTORS_1ST = NO -SORT_GROUP_NAMES = NO -SORT_BY_SCOPE_NAME = NO -STRICT_PROTO_MATCHING = NO -GENERATE_TODOLIST = YES -GENERATE_TESTLIST = YES -GENERATE_BUGLIST = YES -GENERATE_DEPRECATEDLIST= YES -ENABLED_SECTIONS = -MAX_INITIALIZER_LINES = 30 -SHOW_USED_FILES = YES -SHOW_DIRECTORIES = NO -SHOW_FILES = YES -SHOW_NAMESPACES = YES -FILE_VERSION_FILTER = -LAYOUT_FILE = -#--------------------------------------------------------------------------- -# configuration options related to warning and progress messages -#--------------------------------------------------------------------------- -QUIET = NO -WARNINGS = YES -WARN_IF_UNDOCUMENTED = YES -WARN_IF_DOC_ERROR = YES -WARN_NO_PARAMDOC = NO -WARN_FORMAT = "$file:$line: $text" -WARN_LOGFILE = -#--------------------------------------------------------------------------- -# configuration options related to the input files -#--------------------------------------------------------------------------- -INPUT = -INPUT_ENCODING = UTF-8 -FILE_PATTERNS = -RECURSIVE = YES -EXCLUDE = -EXCLUDE_SYMLINKS = NO -EXCLUDE_PATTERNS = */tests/* */doc/* */docs/* */.git/* -EXCLUDE_SYMBOLS = -EXAMPLE_PATH = -EXAMPLE_PATTERNS = -EXAMPLE_RECURSIVE = NO -IMAGE_PATH = -INPUT_FILTER = -FILTER_PATTERNS = -FILTER_SOURCE_FILES = NO -FILTER_SOURCE_PATTERNS = -#--------------------------------------------------------------------------- -# configuration options related to source browsing -#--------------------------------------------------------------------------- -SOURCE_BROWSER = YES -INLINE_SOURCES = YES -STRIP_CODE_COMMENTS = YES -REFERENCED_BY_RELATION = NO -REFERENCES_RELATION = NO -REFERENCES_LINK_SOURCE = YES -USE_HTAGS = NO -VERBATIM_HEADERS = YES -#--------------------------------------------------------------------------- -# configuration options related to the alphabetical class index -#--------------------------------------------------------------------------- -ALPHABETICAL_INDEX = YES -COLS_IN_ALPHA_INDEX = 5 -IGNORE_PREFIX = -#--------------------------------------------------------------------------- -# configuration options related to the HTML output -#--------------------------------------------------------------------------- -GENERATE_HTML = YES -HTML_OUTPUT = html -HTML_FILE_EXTENSION = .html -HTML_HEADER = -HTML_FOOTER = -HTML_STYLESHEET = -HTML_COLORSTYLE_HUE = 220 -HTML_COLORSTYLE_SAT = 100 -HTML_COLORSTYLE_GAMMA = 80 -HTML_TIMESTAMP = YES -HTML_ALIGN_MEMBERS = YES -HTML_DYNAMIC_SECTIONS = NO -GENERATE_DOCSET = NO -DOCSET_FEEDNAME = "Doxygen generated docs" -DOCSET_BUNDLE_ID = org.doxygen.Project -DOCSET_PUBLISHER_ID = org.doxygen.Publisher -DOCSET_PUBLISHER_NAME = Publisher -GENERATE_HTMLHELP = NO -CHM_FILE = -HHC_LOCATION = -GENERATE_CHI = NO -CHM_INDEX_ENCODING = -BINARY_TOC = NO -TOC_EXPAND = NO -GENERATE_QHP = NO -QCH_FILE = -QHP_NAMESPACE = org.doxygen.Project -QHP_VIRTUAL_FOLDER = doc -QHP_CUST_FILTER_NAME = -QHP_CUST_FILTER_ATTRS = -QHP_SECT_FILTER_ATTRS = -QHG_LOCATION = -GENERATE_ECLIPSEHELP = NO -ECLIPSE_DOC_ID = org.doxygen.Project -DISABLE_INDEX = NO -ENUM_VALUES_PER_LINE = 4 -GENERATE_TREEVIEW = YES -USE_INLINE_TREES = YES -TREEVIEW_WIDTH = 250 -EXT_LINKS_IN_WINDOW = NO -FORMULA_FONTSIZE = 10 -FORMULA_TRANSPARENT = YES -USE_MATHJAX = NO -MATHJAX_RELPATH = http://www.mathjax.org/mathjax -SEARCHENGINE = YES -SERVER_BASED_SEARCH = NO -#--------------------------------------------------------------------------- -# configuration options related to the LaTeX output -#--------------------------------------------------------------------------- -GENERATE_LATEX = YES -LATEX_OUTPUT = latex -LATEX_CMD_NAME = latex -MAKEINDEX_CMD_NAME = makeindex -COMPACT_LATEX = NO -PAPER_TYPE = a4 -EXTRA_PACKAGES = -LATEX_HEADER = -PDF_HYPERLINKS = YES -USE_PDFLATEX = YES -LATEX_BATCHMODE = NO -LATEX_HIDE_INDICES = NO -LATEX_SOURCE_CODE = NO -#--------------------------------------------------------------------------- -# configuration options related to the RTF output -#--------------------------------------------------------------------------- -GENERATE_RTF = NO -RTF_OUTPUT = rtf -COMPACT_RTF = NO -RTF_HYPERLINKS = NO -RTF_STYLESHEET_FILE = -RTF_EXTENSIONS_FILE = -#--------------------------------------------------------------------------- -# configuration options related to the man page output -#--------------------------------------------------------------------------- -GENERATE_MAN = NO -MAN_OUTPUT = man -MAN_EXTENSION = .3 -MAN_LINKS = NO -#--------------------------------------------------------------------------- -# configuration options related to the XML output -#--------------------------------------------------------------------------- -GENERATE_XML = NO -XML_OUTPUT = xml -XML_SCHEMA = -XML_DTD = -XML_PROGRAMLISTING = YES -#--------------------------------------------------------------------------- -# configuration options for the AutoGen Definitions output -#--------------------------------------------------------------------------- -GENERATE_AUTOGEN_DEF = NO -#--------------------------------------------------------------------------- -# configuration options related to the Perl module output -#--------------------------------------------------------------------------- -GENERATE_PERLMOD = NO -PERLMOD_LATEX = NO -PERLMOD_PRETTY = YES -PERLMOD_MAKEVAR_PREFIX = -#--------------------------------------------------------------------------- -# Configuration options related to the preprocessor -#--------------------------------------------------------------------------- -ENABLE_PREPROCESSING = YES -MACRO_EXPANSION = NO -EXPAND_ONLY_PREDEF = NO -SEARCH_INCLUDES = YES -INCLUDE_PATH = -INCLUDE_FILE_PATTERNS = -PREDEFINED = -EXPAND_AS_DEFINED = -SKIP_FUNCTION_MACROS = NO -#--------------------------------------------------------------------------- -# Configuration::additions related to external references -#--------------------------------------------------------------------------- -TAGFILES = -GENERATE_TAGFILE = -ALLEXTERNALS = NO -EXTERNAL_GROUPS = YES -PERL_PATH = /usr/bin/perl -#--------------------------------------------------------------------------- -# Configuration options related to the dot tool -#--------------------------------------------------------------------------- -CLASS_DIAGRAMS = YES -MSCGEN_PATH = -HIDE_UNDOC_RELATIONS = YES -HAVE_DOT = YES -DOT_NUM_THREADS = 0 -DOT_FONTNAME = Helvetica -DOT_FONTSIZE = 10 -DOT_FONTPATH = -CLASS_GRAPH = YES -COLLABORATION_GRAPH = YES -GROUP_GRAPHS = YES -UML_LOOK = YES -TEMPLATE_RELATIONS = NO -INCLUDE_GRAPH = YES -INCLUDED_BY_GRAPH = YES -CALL_GRAPH = YES -CALLER_GRAPH = YES -GRAPHICAL_HIERARCHY = YES -DIRECTORY_GRAPH = YES -DOT_IMAGE_FORMAT = png -DOT_PATH = -DOTFILE_DIRS = -MSCFILE_DIRS = -DOT_GRAPH_MAX_NODES = 50 -MAX_DOT_GRAPH_DEPTH = 0 -DOT_TRANSPARENT = YES -DOT_MULTI_TARGETS = NO -GENERATE_LEGEND = YES -DOT_CLEANUP = YES diff --git a/.gitignore b/.gitignore index d675cd1..d9c4a5c 100644 --- a/.gitignore +++ b/.gitignore @@ -9,17 +9,15 @@ Makefile Makefile.in /config* m4/ -/docs/ -/INSTALL -coverage.base -coverage.run -coverage.info -coveragereport/ *.m4 +/INSTALL +tests/coverage* +/docs/api/ +/docs/Doxyfile +/run /autom4te.cache/ /compile /depcomp -/docs/ /install-sh /libtool /ltmain.sh diff --git a/docs/Doxyfile.in b/docs/Doxyfile.in index 5153c56..34f4ab1 100644 --- a/docs/Doxyfile.in +++ b/docs/Doxyfile.in @@ -20,7 +20,7 @@ DOXYFILE_ENCODING = UTF-8 PROJECT_NAME = @PACKAGE_NAME@ PROJECT_NUMBER = @PACKAGE_VERSION@ PROJECT_BRIEF = "Web server and task management solution." -OUTPUT_DIRECTORY = @PACKAGE_VERSION@ +OUTPUT_DIRECTORY = @top_srcdir@/docs/api/@PACKAGE_VERSION@ CREATE_SUBDIRS = NO OUTPUT_LANGUAGE = English BRIEF_MEMBER_DESC = YES diff --git a/docs/Makefile.am b/docs/Makefile.am index 41d615a..d9da722 100644 --- a/docs/Makefile.am +++ b/docs/Makefile.am @@ -1,19 +1,13 @@ if HAVE_DOXYGEN -# directory = $(top_srcdir)/docs/man/man3/ -# -# dist_man_MANS = $(directory)/man_page_1.3 $(directory)/man_page_2.3 -# $(directory)/man_page_1.3: doxyfile.stamp -# $(directory)/man_page_2.3: doxyfile.stamp EXTRA_DIST = Doxyfile.in .PHONY: docs docs: - mkdir $(PACKAGE_VERSION) + @mkdir -p $(top_srcdir)/docs/api/$(PACKAGE_VERSION) $(DOXYGEN) Doxyfile - echo Timestamp > doxyfile.stamp clean-local: - rm -rf $(top_srcdir)/docs/$(PACKAGE_VERSION) + @rm -rf $(top_srcdir)/docs/docs/$(PACKAGE_VERSION) endif diff --git a/include/auth/storage.h b/include/auth/storage.h index 7fb6d24..85ba557 100644 --- a/include/auth/storage.h +++ b/include/auth/storage.h @@ -39,8 +39,8 @@ CLASS(AuthStorage) { Storage store; }; -/* - * @TODO In future this should use a more general purpose hash +/** + * \todo In future this should use a more general purpose hash * function, which then will be in utils/hash.c */ int hash_pw(const char *, const size_t, unsigned char *, unsigned char **); diff --git a/include/queue.h b/include/queue.h index 586bcc9..05f6f9c 100644 --- a/include/queue.h +++ b/include/queue.h @@ -40,7 +40,8 @@ CLASS(Queue) { * first and last are only available in the initial queue * element (the root). This elelment does not contain any message * and exists only for organizational purpose. - * @TODO next and first always have to be the same...so get rid + * + * \todo next and first always have to be the same...so get rid * of first. */ Queue first; diff --git a/src/application/application.c b/src/application/application.c index 9f8e476..04eda1e 100644 --- a/src/application/application.c +++ b/src/application/application.c @@ -41,8 +41,8 @@ applicationCtor(void * _this, va_list * params) this->val = va_arg(*params, struct randval *); - /* - * @TODO for both of these...each user should be identified + /** + * \todo for both of these...each user should be identified * by a number...that way I could use that number in the * passwords db and no direct association between email and * password could be made when someone get the hands on the diff --git a/src/application/login.c b/src/application/login.c index b661911..237e16c 100644 --- a/src/application/login.c +++ b/src/application/login.c @@ -53,7 +53,7 @@ applicationLogin( if (NULL == userLoad(session->user, this->users)) { // this is an ldap user that has not yet set // additional user informations. - /* @TODO again...change the keys to id's */ + /** \todo again...change the keys to id's */ session->user->email = NULL; delete(session->user); session->user = new(User, diff --git a/src/application/signup.c b/src/application/signup.c index 0784e8d..f6a3114 100644 --- a/src/application/signup.c +++ b/src/application/signup.c @@ -61,8 +61,8 @@ applicationSignup( CRED_PWD(cred).npass, hash, &salt)) { - /* - * @TODO if we come here we have to delete the previously saved + /** + * \todo if we come here we have to delete the previously saved * user again... */ return 0; diff --git a/src/auth/ldap.c b/src/auth/ldap.c index f78780f..efffdf1 100644 --- a/src/auth/ldap.c +++ b/src/auth/ldap.c @@ -113,7 +113,7 @@ authLdapAuthenticate(void * _this, Credential cred) } //fprintf(stderr, "%s\n", ldap_err2string(ldap_err)); - // @TODO do error logging instead. + /** \todo do error logging instead. */ return FALSE; } diff --git a/src/stream/write.c b/src/stream/write.c index 00aa9aa..b13638f 100644 --- a/src/stream/write.c +++ b/src/stream/write.c @@ -63,8 +63,8 @@ streamWrite(Stream this, void * buf, size_t count) break; case STREAM_SSL: - /* - * @TODO I got a segfault in this call under unclear + /** + * \todo I got a segfault in this call under unclear * circumstances. Most likely it has to do with a * write on a closed connection. */ diff --git a/src/user/save.c b/src/user/save.c index 5f7a505..e8a3ce0 100644 --- a/src/user/save.c +++ b/src/user/save.c @@ -39,8 +39,8 @@ userSave(User this, Storage storage) *this->nsurname + 1 + 3 * sizeof(size_t); - /* - * @TODO user return value for error handling + /** + * \todo user return value for error handling */ storageUpdate( storage,