# comments will behave just like regular Qt-style comments
# (thus requiring an explicit @brief command for a brief description.)
-JAVADOC_AUTOBRIEF = YES
+JAVADOC_AUTOBRIEF = NO
# If the QT_AUTOBRIEF tag is set to YES then Doxygen will
# interpret the first line (until the first dot) of a Qt-style
# For instance, some of the names that are used will be different. The list
# of all members will be omitted, etc.
-OPTIMIZE_OUTPUT_FOR_C = NO
+OPTIMIZE_OUTPUT_FOR_C = YES
# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
# sources only. Doxygen will then generate output that is more tailored for
# to NO (the default) then the documentation will be excluded.
# Set it to YES to include the internal documentation.
-INTERNAL_DOCS = NO
+INTERNAL_DOCS = YES
# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
# file names in lower-case letters. If set to YES upper-case letters are also
# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
# in the documentation. The default is NO.
-SHOW_DIRECTORIES = NO
+SHOW_DIRECTORIES = YES
# Set the SHOW_FILES tag to NO to disable the generation of the Files page.
# This will remove the Files entry from the Quick Index and from the
# Folder Tree View (if specified). The default is YES.
-SHOW_FILES = NO
+SHOW_FILES = YES
# Set the SHOW_NAMESPACES tag to NO to disable the generation of the
# Namespaces page.
# directories like "/usr/src/myproject". Separate the files or directories
# with spaces.
-INPUT = cli misc remote
+INPUT = include cli misc remote
# 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
automatically spot simple errors
- write code in a way so that valgrind is happy
- ...
+
+DOXYGEN
+
+- if a function has a prototype in a header file and the implementation in a
+ source file then document it in the source file only
+- if an enum or macro is defined only in a header file document it there
+- use the /*! ... style, not the /** ... style
+- use the @brief style, not the \brief style
+- mark the brief line explicitly with @brief
+- mark internal functions and types with @internal
+- ...
all: $(TARGET)
clean:
- rm -rf $(TARGET) $(OBJS)
+ rm -rf $(TARGET) $(OBJS) $(CLEAN_PATTERNS)
install: install-target-lib
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
+/*!
+ * @file
+ */
+
#include <string.h>
#include <libvscmisc/assert.h>
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
+/*!
+ * @file
+ */
+
#ifndef __VSC_CLI__COMMAND__PRIVATE_H__
#define __VSC_CLI__COMMAND__PRIVATE_H__
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
+/*!
+ * @file
+ */
+
#include <malloc.h>
#include <readline/readline.h>
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
+/*!
+ * @file
+ */
+
#include <stdarg.h>
#include <stdio.h>
#include <string.h>
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
+/*!
+ * @file
+ */
+
#include <string.h>
#include <libvscmisc/assert.h>
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
+/*!
+ * @file
+ */
+
#ifndef __VSC_CLI__OPTION__PRIVATE_H__
#define __VSC_CLI__OPTION__PRIVATE_H__
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
+/*!
+ * @file
+ */
+
#include <libvscmisc/assert.h>
#include <libvscmisc/error.h>
#include <libvscmisc/memory.h>
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
+/*!
+ * @file
+ */
+
#ifndef __VSC_CLI__TOKEN_H__
#define __VSC_CLI__TOKEN_H__
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
+/*!
+ * @file
+ */
+
#ifndef __VSC_CLI__COMMAND_H__
#define __VSC_CLI__COMMAND_H__
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
+/*!
+ * @file
+ */
+
#ifndef __VSC_CLI__CORE_H__
#define __VSC_CLI__CORE_H__
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
+/*!
+ * @file
+ */
+
#ifndef __VSC_CLI__HELP_H__
#define __VSC_CLI__HELP_H__
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
+/*!
+ * @file
+ */
+
#ifndef __VSC_CLI_H__
#define __VSC_CLI_H__
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
+/*!
+ * @file
+ */
+
#ifndef __VSC_CLI__OPTION_H__
#define __VSC_CLI__OPTION_H__
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
+/*!
+ * @file
+ */
+
#ifndef __VSC_CLI__TYPES_H__
#define __VSC_CLI__TYPES_H__
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
+/*!
+ * @file
+ */
+
#ifndef __VSC_MISC__ASSERT_H__
#define __VSC_MISC__ASSERT_H__
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
+/*!
+ * @file
+ */
+
#ifndef __VSC_MISC__DEBUG_H__
#define __VSC_MISC__DEBUG_H__
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
+/*!
+ * @file
+ */
+
#ifndef __VSC_MISC__ERROR_H__
#define __VSC_MISC__ERROR_H__
void
vsc_error_cleanup (struct VscError *error);
-/**
- * Returns the string representaion of the error code.
- *
- * The string must not be freed by the caller.
- */
const char * /* error_string */
vsc_error_string (enum VscErrorCode code);
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
+/*!
+ * @file
+ */
+
#ifndef __VSC_MISC__FILESYSTEM_H__
#define __VSC_MISC__FILESYSTEM_H__
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
+/*!
+ * @file
+ */
+
#ifndef __VSC_MISC_H__
#define __VSC_MISC_H__
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
+/*!
+ * @file
+ */
+
#ifndef __VSC_MISC__LIST_H__
#define __VSC_MISC__LIST_H__
extern "C" {
#endif
-/**
- * Returns the last item from the list.
- */
struct VscList * /* last_item */
vsc_list_get_last (struct VscList *list);
-/**
- * Appends a duplicate of the item to the list.
- *
- * If an error occurs then the list is untouched.
- */
void
vsc_list_append (struct VscError *error, struct VscList **list,
struct VscList *item,
VscList_DuplicateFunction duplicate_function,
VscList_FreeFunction free_function);
-/**
- * Looks up an item in the list.
- *
- * The first item for that the match function returns TRUE is returned. If no
- * match occurs NULL is returned.
- */
struct VscList * /* item */
vsc_list_lookup (const struct VscList *list,
VscList_MatchFunction match_function, void *match_data);
-/**
- * Removes the item from the list and frees it.
- *
- * If the list becomes empty then the pointer to the list is set to NULL.
- *
- * If the item is not in the list then the list is untouched.
- */
void
vsc_list_remove (struct VscList **list, struct VscList *item,
VscList_FreeFunction free_function);
-/**
- * Recursively frees the list and the pointer to the list is set to NULL.
- */
void
vsc_list_free (struct VscList **list, VscList_FreeFunction free_function);
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
+/*!
+ * @file
+ */
+
#ifndef __VSC_MISC__MEMORY_H__
#define __VSC_MISC__MEMORY_H__
void *
vsc_alloc (struct VscError *error, size_t size);
-/**
- * Frees the block of memory at which the pointer pointed at by ptrptr points
- * and sets the pointer pointed at by ptrptr to NULL.
- *
- * void *ptr = vsc_alloc (error, 42);
- * ...
- * vsc_free (&ptr);
- */
void
vsc_free (void *ptrptr);
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
+/*!
+ * @file
+ */
+
#ifndef __VSC_MISC__STRING_H__
#define __VSC_MISC__STRING_H__
const char *
vsc_strerror (int errnum);
-/**
- * Stricter version of strtol, returning an int as result.
- *
- * If tail is NULL there must be no non-number character at the end of the
- * string, otherwise an error occurs.
- */
int
vsc_strtoi (struct VscError *error, const char *string, char **tail, int base);
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
+/*!
+ * @file
+ */
+
#ifndef __VSC_MISC__TYPES_H__
#define __VSC_MISC__TYPES_H__
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
+/*!
+ * @file
+ */
+
#ifndef __VSC_REMOTE_H__
#define __VSC_REMOTE_H__
all: $(TARGET)
clean:
- rm -rf $(TARGET) $(OBJS)
+ rm -rf $(TARGET) $(OBJS) $(CLEAN_PATTERNS)
install: install-target-lib
#include "../include/libvscmisc/error.h"
#include "../include/libvscmisc/list.h"
-/**
- * Returns the last item from the list.
+/*!
+ * @brief Returns the last item from the list.
*/
struct VscList * /* last_item */
vsc_list_get_last (struct VscList *list)
return item;
}
-/**
- * Appends a duplicate of the item to the list.
+/*!
+ * @brief Appends a duplicate of the item to the list.
*
* If an error occurs then the list is untouched.
*/
return list_duplicate;
}
-/**
- * Looks up an item in the list.
+/*!
+ * @brief Looks up an item in the list.
*
* The first item for that the match function returns TRUE is returned. If no
* match occurs NULL is returned.
return NULL;
}
-/**
- * Removes the item from the list and frees it.
+/*!
+ * @brief Removes the item from the list and frees it.
*
* If the list becomes empty then the pointer to the list is set to NULL.
*
}
}
-/**
- * Recursively frees the list and set the list pointer to NULL.
+/*!
+ * @brief Recursively frees the list and set the list pointer to NULL.
*/
void
vsc_list_free (struct VscList **list, VscList_FreeFunction free_function)
return ptr;
}
-/**
- * Frees the block of memory at which the pointer pointed at by ptrptr points
- * and sets the pointer pointed at by ptrptr to NULL.
+/*!
+ * @brief Frees the block of memory at which the pointer pointed at by ptrptr
+ * points and sets the pointer pointed at by ptrptr to NULL.
*
+ * @code
* void *ptr = vsc_alloc (error, 42);
* ...
* vsc_free (&ptr);
+ * @endcode
*/
void
vsc_free (void *ptrptr)
}
}
-/**
- * Stricter version of strtol, returning an int as result.
+/*!
+ * @brief Stricter version of strtol, returning an int as result.
*
* If tail is NULL there must be no non-number character at the end of the
* string, otherwise an error occurs.
all: $(TARGET)
clean:
- rm -rf $(TARGET) $(OBJS)
+ rm -rf $(TARGET) $(OBJS) $(CLEAN_PATTERNS)
install: install-target-lib
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
+/*!
+ * @file
+ */
+
#include <termios.h>
#include <xmlrpc-c/client.h>
projects / vsc-common.git / commitdiff