2abe1f
From 31d85c66cce07fedd0c8eba7dfba27ed573a26e9 Mon Sep 17 00:00:00 2001
278948
From: rpm-build <rpm-build>
278948
Date: Mon, 26 Jan 2015 12:57:11 -0800
278948
Subject: [PATCH] libiscsi
0e55d5
0e55d5
---
0e55d5
 Makefile                                    |    2 +
0e55d5
 libiscsi/Makefile                           |   61 ++
278948
 libiscsi/libiscsi.c                         |  617 +++++++++++
0e55d5
 libiscsi/libiscsi.doxy                      | 1473 +++++++++++++++++++++++++++
0e55d5
 libiscsi/libiscsi.h                         |  344 +++++++
278948
 libiscsi/no_date_footer.html                |    6 +
278948
 libiscsi/pylibiscsi.c                       |  709 +++++++++++++
0e55d5
 libiscsi/setup.py                           |    9 +
0e55d5
 libiscsi/tests/test_discovery_firmware.c    |   53 +
0e55d5
 libiscsi/tests/test_discovery_sendtargets.c |   60 ++
0e55d5
 libiscsi/tests/test_get_auth.c              |   70 ++
0e55d5
 libiscsi/tests/test_get_initiator_name.c    |   38 +
0e55d5
 libiscsi/tests/test_get_network_config.c    |   45 +
0e55d5
 libiscsi/tests/test_login.c                 |   52 +
0e55d5
 libiscsi/tests/test_logout.c                |   51 +
0e55d5
 libiscsi/tests/test_params.c                |  103 ++
0e55d5
 libiscsi/tests/test_set_auth.c              |   58 ++
0e55d5
 usr/Makefile                                |    2 +-
0e55d5
 usr/discovery.c                             |    5 +
0e55d5
 usr/idbm.c                                  |    6 +-
0e55d5
 usr/idbm.h                                  |    3 +
0e55d5
 usr/iscsi_ipc.h                             |    2 +
278948
 22 files changed, 3765 insertions(+), 4 deletions(-)
0e55d5
 create mode 100644 libiscsi/Makefile
0e55d5
 create mode 100644 libiscsi/libiscsi.c
0e55d5
 create mode 100644 libiscsi/libiscsi.doxy
0e55d5
 create mode 100644 libiscsi/libiscsi.h
278948
 create mode 100644 libiscsi/no_date_footer.html
0e55d5
 create mode 100644 libiscsi/pylibiscsi.c
0e55d5
 create mode 100644 libiscsi/setup.py
0e55d5
 create mode 100644 libiscsi/tests/test_discovery_firmware.c
0e55d5
 create mode 100644 libiscsi/tests/test_discovery_sendtargets.c
0e55d5
 create mode 100644 libiscsi/tests/test_get_auth.c
0e55d5
 create mode 100644 libiscsi/tests/test_get_initiator_name.c
0e55d5
 create mode 100644 libiscsi/tests/test_get_network_config.c
0e55d5
 create mode 100644 libiscsi/tests/test_login.c
0e55d5
 create mode 100644 libiscsi/tests/test_logout.c
0e55d5
 create mode 100644 libiscsi/tests/test_params.c
0e55d5
 create mode 100644 libiscsi/tests/test_set_auth.c
0e55d5
0e55d5
diff --git a/Makefile b/Makefile
2abe1f
index c8cd00e..cf028cf 100644
0e55d5
--- a/Makefile
0e55d5
+++ b/Makefile
2abe1f
@@ -43,6 +43,7 @@ user: iscsiuio/Makefile
0e55d5
 	$(MAKE) -C usr
0e55d5
 	$(MAKE) -C utils
c2d5d2
 	$(MAKE) -C iscsiuio
0e55d5
+	$(MAKE) -C libiscsi
0e55d5
 	@echo
0e55d5
 	@echo "Compilation complete                 Output file"
0e55d5
 	@echo "-----------------------------------  ----------------"
2abe1f
@@ -71,6 +72,7 @@ kernel: force
0e55d5
 force: ;
0e55d5
 
0e55d5
 clean:
0e55d5
+	$(MAKE) -C libiscsi clean
0e55d5
 	$(MAKE) -C utils/sysdeps clean
0e55d5
 	$(MAKE) -C utils/fwparam_ibft clean
0e55d5
 	$(MAKE) -C utils clean
0e55d5
diff --git a/libiscsi/Makefile b/libiscsi/Makefile
0e55d5
new file mode 100644
0e55d5
index 0000000..317a7ec
0e55d5
--- /dev/null
0e55d5
+++ b/libiscsi/Makefile
0e55d5
@@ -0,0 +1,61 @@
0e55d5
+# This Makefile will work only with GNU make.
0e55d5
+
0e55d5
+OSNAME=$(shell uname -s)
0e55d5
+OPTFLAGS ?= -O2 -g
0e55d5
+WARNFLAGS ?= -Wall -Wstrict-prototypes
0e55d5
+CFLAGS = $(OPTFLAGS) $(WARNFLAGS) -I../include -I../usr \
0e55d5
+		-D$(OSNAME) -fPIC -D_GNU_SOURCE -fvisibility=hidden
0e55d5
+LIB = libiscsi.so.0
0e55d5
+TESTS = tests/test_discovery_sendtargets tests/test_discovery_firmware
0e55d5
+TESTS += tests/test_login tests/test_logout tests/test_params
0e55d5
+TESTS += tests/test_get_network_config tests/test_get_initiator_name
0e55d5
+TESTS += tests/test_set_auth tests/test_get_auth
0e55d5
+
0e55d5
+COMMON_SRCS = sysdeps.o
0e55d5
+# sources shared between iscsid, iscsiadm and iscsistart
0e55d5
+ISCSI_LIB_SRCS = netlink.o transport.o cxgbi.o be2iscsi.o iscsi_timer.o initiator_common.o iscsi_err.o session_info.o iscsi_util.o io.o auth.o discovery.o login.o log.o md5.o sha1.o iface.o idbm.o sysfs.o iscsi_sysfs.o iscsi_net_util.o iscsid_req.o iser.o uip_mgmt_ipc.o
0e55d5
+FW_PARAM_SRCS = fw_entry.o prom_lex.o prom_parse.tab.o fwparam_ppc.o fwparam_sysfs.o
0e55d5
+
0e55d5
+# sources shared with the userspace utils, note we build these separately
0e55d5
+# to get PIC versions.
0e55d5
+COMMON_OBJS = $(patsubst %.o, common-objs/%.o, $(COMMON_SRCS))
0e55d5
+USR_OBJS = $(patsubst %.o, usr-objs/%.o, $(ISCSI_LIB_SRCS) strings.o)
0e55d5
+FW_OBJS = $(patsubst %.o, fw-objs/%.o, $(FW_PARAM_SRCS))
0e55d5
+
0e55d5
+# Flags for the tests
0e55d5
+tests/% : CFLAGS = $(OPTFLAGS) $(WARNFLAGS) -I.
0e55d5
+
0e55d5
+all: lib tests html
0e55d5
+
0e55d5
+lib: $(LIB)
0e55d5
+tests: $(TESTS)
0e55d5
+
0e55d5
+common-objs/%.o: ../utils/sysdeps/%.c
0e55d5
+	mkdir -p common-objs
0e55d5
+	$(CC) $(CFLAGS) -c $< -o $@
0e55d5
+
0e55d5
+usr-objs/%.o: ../usr/%.c
0e55d5
+	mkdir -p usr-objs
0e55d5
+	$(CC) $(CFLAGS) -c $< -o $@
0e55d5
+
0e55d5
+fw-objs/%.o: ../utils/fwparam_ibft/%.c
0e55d5
+	mkdir -p fw-objs
0e55d5
+	$(CC) $(CFLAGS) -c $< -o $@
0e55d5
+
0e55d5
+$(LIB): $(COMMON_OBJS) $(FW_OBJS) $(USR_OBJS) libiscsi.o
0e55d5
+	$(CC) $(CFLAGS) -shared -Wl,-soname,$(LIB) $^ -o $@
0e55d5
+	ln -s -f $(LIB) libiscsi.so
0e55d5
+
0e55d5
+$(TESTS): $(FW_OBJS) $(COMMON_OBJS) $(USR_OBJS) $(LIB)
0e55d5
+
0e55d5
+html: libiscsi.h libiscsi.doxy
0e55d5
+	doxygen libiscsi.doxy
0e55d5
+
0e55d5
+clean:
0e55d5
+	rm -rf *.o common-objs usr-objs fw-objs libuip-objs libiscsi.so* \
0e55d5
+			.depend *~ html $(TESTS) tests/*~
0e55d5
+
0e55d5
+depend:
0e55d5
+	gcc $(CFLAGS) -M `ls *.c` > .depend
0e55d5
+
0e55d5
+-include .depend ../usr/.depend
0e55d5
diff --git a/libiscsi/libiscsi.c b/libiscsi/libiscsi.c
0e55d5
new file mode 100644
278948
index 0000000..064e4b5
0e55d5
--- /dev/null
0e55d5
+++ b/libiscsi/libiscsi.c
278948
@@ -0,0 +1,617 @@
5ebdd5
+/*
5ebdd5
+ * iSCSI Administration library
5ebdd5
+ *
5ebdd5
+ * Copyright (C) 2008-2009 Red Hat, Inc. All rights reserved.
5ebdd5
+ * Copyright (C) 2008-2009 Hans de Goede <hdegoede@redhat.com>
5ebdd5
+ * maintained by open-iscsi@googlegroups.com
5ebdd5
+ *
5ebdd5
+ * This program is free software; you can redistribute it and/or modify
5ebdd5
+ * it under the terms of the GNU General Public License as published
5ebdd5
+ * by the Free Software Foundation; either version 2 of the License, or
5ebdd5
+ * (at your option) any later version.
5ebdd5
+ *
5ebdd5
+ * This program is distributed in the hope that it will be useful, but
5ebdd5
+ * WITHOUT ANY WARRANTY; without even the implied warranty of
5ebdd5
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
5ebdd5
+ * General Public License for more details.
5ebdd5
+ *
5ebdd5
+ * See the file COPYING included with this distribution for more details.
5ebdd5
+ */
5ebdd5
+
5ebdd5
+#include <stdio.h>
5ebdd5
+#include <stdlib.h>
5ebdd5
+#include <string.h>
5ebdd5
+#include <errno.h>
5ebdd5
+#include <unistd.h>
5ebdd5
+#include <sys syslog.h="">
5ebdd5
+#include "libiscsi.h"
5ebdd5
+#include "idbm.h"
5ebdd5
+#include "discovery.h"
5ebdd5
+#include "log.h"
5ebdd5
+#include "sysfs.h"
5ebdd5
+#include "iscsi_sysfs.h"
5ebdd5
+#include "session_info.h"
5ebdd5
+#include "iscsi_util.h"
5ebdd5
+#include "sysdeps.h"
5ebdd5
+#include "iface.h"
5ebdd5
+#include "iscsi_proto.h"
5ebdd5
+#include "fw_context.h"
5ebdd5
+#include "iscsid_req.h"
Mike Christie 3949e1
+#include "iscsi_err.h"
5ebdd5
+
5ebdd5
+#define CHECK(a) { context->error_str[0] = 0; rc = a; if (rc) goto leave; }
5ebdd5
+
Mike Christie 3949e1
+/* UGLY, not thread safe :( */
Mike Christie 3949e1
+static int sysfs_initialized = 0;
Mike Christie 3949e1
+
5ebdd5
+struct libiscsi_context {
5ebdd5
+	char error_str[256];
5ebdd5
+	/* For get_parameter_helper() */
5ebdd5
+	const char *parameter;
5ebdd5
+	char *value;
5ebdd5
+};
5ebdd5
+
5ebdd5
+static void libiscsi_log(int prio, void *priv, const char *fmt, va_list ap)
5ebdd5
+{
5ebdd5
+	struct libiscsi_context *context = priv;
5ebdd5
+
5ebdd5
+	if (prio > LOG_ERR) /* We are only interested in errors (or worse) */
5ebdd5
+		return;
5ebdd5
+
5ebdd5
+	vsnprintf(context->error_str, sizeof(context->error_str), fmt, ap);
5ebdd5
+}
5ebdd5
+
5ebdd5
+struct libiscsi_context *libiscsi_init(void)
5ebdd5
+{
5ebdd5
+	struct libiscsi_context *context;
5ebdd5
+
5ebdd5
+	context = calloc(1, sizeof *context);
5ebdd5
+	if (!context)
5ebdd5
+		return NULL;
5ebdd5
+
5ebdd5
+	log_init("libiscsi", 1024, libiscsi_log, context);
Mike Christie 3949e1
+	if (!sysfs_initialized) {
Mike Christie 3949e1
+		sysfs_init();
Mike Christie 3949e1
+		sysfs_initialized = 1;
Mike Christie 3949e1
+	}
5ebdd5
+	increase_max_files();
5ebdd5
+	if (idbm_init(NULL)) {
5ebdd5
+		sysfs_cleanup();
5ebdd5
+		free(context);
5ebdd5
+		return NULL;
5ebdd5
+	}
5ebdd5
+
5ebdd5
+	iface_setup_host_bindings();
5ebdd5
+
5ebdd5
+	return context;
5ebdd5
+}
5ebdd5
+
5ebdd5
+void libiscsi_cleanup(struct libiscsi_context *context)
5ebdd5
+{
5ebdd5
+	idbm_terminate();
5ebdd5
+	free_transports();
5ebdd5
+	sysfs_cleanup();
5ebdd5
+	free(context);
5ebdd5
+}
5ebdd5
+
Mike Christie 3949e1
+static void free_iface_list(struct list_head *ifaces)
Mike Christie 3949e1
+{
Mike Christie 3949e1
+	struct iface_rec *iface, *tmp_iface;
Mike Christie 3949e1
+
Mike Christie 3949e1
+	list_for_each_entry_safe(iface, tmp_iface, ifaces, list) {
Mike Christie 3949e1
+		list_del(&iface->list);
Mike Christie 3949e1
+		free(iface);
Mike Christie 3949e1
+	}
Mike Christie 3949e1
+}
Mike Christie 3949e1
+
5ebdd5
+static void free_rec_list(struct list_head *rec_list)
5ebdd5
+{
5ebdd5
+	struct node_rec *rec, *tmp;
5ebdd5
+	
5ebdd5
+	list_for_each_entry_safe(rec, tmp, rec_list, list) {
5ebdd5
+		list_del(&rec->list);
5ebdd5
+		free(rec);
5ebdd5
+	}
5ebdd5
+}
5ebdd5
+
5ebdd5
+int libiscsi_discover_sendtargets(struct libiscsi_context *context,
5ebdd5
+	const char *address, int port,
5ebdd5
+	const struct libiscsi_auth_info *auth_info,
5ebdd5
+	int *nr_found, struct libiscsi_node **found_nodes)
5ebdd5
+{
5ebdd5
+	struct discovery_rec drec;
5ebdd5
+	LIST_HEAD(bound_rec_list);
5ebdd5
+	struct node_rec *rec;
5ebdd5
+	int rc = 0, found = 0;
5ebdd5
+
5ebdd5
+	INIT_LIST_HEAD(&bound_rec_list);
5ebdd5
+
5ebdd5
+	if (nr_found)
5ebdd5
+		*nr_found = 0;
5ebdd5
+	if (found_nodes)
5ebdd5
+		*found_nodes = NULL;
5ebdd5
+
5ebdd5
+	CHECK(libiscsi_verify_auth_info(context, auth_info))
5ebdd5
+
5ebdd5
+	/* Fill the drec struct with all needed info */
5ebdd5
+	memset(&drec, 0, sizeof drec);
5ebdd5
+	idbm_sendtargets_defaults(&drec.u.sendtargets);
5ebdd5
+	drec.type = DISCOVERY_TYPE_SENDTARGETS;
5ebdd5
+	strlcpy(drec.address, address, sizeof(drec.address));
5ebdd5
+	drec.port = port ? port : ISCSI_LISTEN_PORT;
5ebdd5
+	switch(auth_info ? auth_info->method : libiscsi_auth_none) {
5ebdd5
+	case libiscsi_auth_chap:
5ebdd5
+		drec.u.sendtargets.auth.authmethod = AUTH_METHOD_CHAP;
5ebdd5
+		strlcpy(drec.u.sendtargets.auth.username,
5ebdd5
+			auth_info->chap.username, AUTH_STR_MAX_LEN);
5ebdd5
+		strlcpy((char *)drec.u.sendtargets.auth.password,
5ebdd5
+			auth_info->chap.password, AUTH_STR_MAX_LEN);
5ebdd5
+		drec.u.sendtargets.auth.password_length =
5ebdd5
+			strlen((char *)drec.u.sendtargets.auth.password);
5ebdd5
+		strlcpy(drec.u.sendtargets.auth.username_in,
5ebdd5
+			auth_info->chap.reverse_username, AUTH_STR_MAX_LEN);
5ebdd5
+		strlcpy((char *)drec.u.sendtargets.auth.password_in,
5ebdd5
+			auth_info->chap.reverse_password, AUTH_STR_MAX_LEN);
5ebdd5
+		drec.u.sendtargets.auth.password_in_length =
5ebdd5
+			strlen((char *)drec.u.sendtargets.auth.password_in);
5ebdd5
+		break;
5ebdd5
+	}
5ebdd5
+
5ebdd5
+	CHECK(idbm_add_discovery(&drec))
5ebdd5
+
5ebdd5
+	CHECK(idbm_bind_ifaces_to_nodes(discovery_sendtargets,
5ebdd5
+					&drec, NULL, &bound_rec_list))
5ebdd5
+
5ebdd5
+	/* now add/update records */
5ebdd5
+	list_for_each_entry(rec, &bound_rec_list, list) {
5ebdd5
+		CHECK(idbm_add_node(rec, &drec, 1 /* overwrite */))
5ebdd5
+		found++;
5ebdd5
+	}
5ebdd5
+
5ebdd5
+	if (nr_found)
5ebdd5
+		*nr_found = found;
5ebdd5
+
5ebdd5
+	if (found_nodes && found) {
5ebdd5
+		*found_nodes = calloc(found, sizeof **found_nodes);
5ebdd5
+		if (*found_nodes == NULL) {
5ebdd5
+			snprintf(context->error_str,
5ebdd5
+				 sizeof(context->error_str), strerror(ENOMEM));
5ebdd5
+			rc = ENOMEM;
5ebdd5
+			goto leave;
5ebdd5
+		}
5ebdd5
+		found = 0;
5ebdd5
+		list_for_each_entry(rec, &bound_rec_list, list) {
5ebdd5
+			strlcpy((*found_nodes)[found].name, rec->name,
5ebdd5
+				 LIBISCSI_VALUE_MAXLEN);
5ebdd5
+			(*found_nodes)[found].tpgt = rec->tpgt;
5ebdd5
+			strlcpy((*found_nodes)[found].address,
5ebdd5
+				 rec->conn[0].address, NI_MAXHOST);
5ebdd5
+			(*found_nodes)[found].port = rec->conn[0].port;
Mike Christie 3949e1
+			strlcpy((*found_nodes)[found].iface,
Mike Christie 3949e1
+				 rec->iface.name, LIBISCSI_VALUE_MAXLEN);
5ebdd5
+			found++;
5ebdd5
+		}
5ebdd5
+	}
5ebdd5
+
5ebdd5
+leave:
5ebdd5
+	free_rec_list(&bound_rec_list);
5ebdd5
+	return rc;
5ebdd5
+}
5ebdd5
+
5ebdd5
+int libiscsi_discover_firmware(struct libiscsi_context *context,
5ebdd5
+	int *nr_found, struct libiscsi_node **found_nodes)
5ebdd5
+{
Mike Christie 3949e1
+	struct list_head targets, ifaces, rec_list;
Mike Christie 3949e1
+	discovery_rec_t drec;
5ebdd5
+	int rc = 0;
5ebdd5
+
Mike Christie 3949e1
+	INIT_LIST_HEAD(&targets);
Mike Christie 3949e1
+	INIT_LIST_HEAD(&ifaces);
Mike Christie 3949e1
+	INIT_LIST_HEAD(&rec_list);
Mike Christie 3949e1
+
Mike Christie 3949e1
+	if (nr_found) {
5ebdd5
+		*nr_found = 0;
Mike Christie 3949e1
+	}
Mike Christie 3949e1
+
Mike Christie 3949e1
+	if (found_nodes) {
5ebdd5
+		*found_nodes = NULL;
Mike Christie 3949e1
+	}
5ebdd5
+
Mike Christie 3949e1
+	rc = fw_get_targets(&targets);
5ebdd5
+	if (rc) {
Mike Christie 3949e1
+		log_error("%s: Could not get list of targets from firmware "
Mike Christie 3949e1
+			  "(err %d).\n", __func__, rc);
5ebdd5
+		return rc;
5ebdd5
+	}
5ebdd5
+
Mike Christie 3949e1
+	CHECK(iface_create_ifaces_from_boot_contexts(&ifaces, &targets));
5ebdd5
+
Mike Christie 3949e1
+	memset(&drec, 0, sizeof(drec));
Mike Christie 3949e1
+	drec.type = DISCOVERY_TYPE_FW;
Mike Christie 3949e1
+	rc = idbm_bind_ifaces_to_nodes(discovery_fw, &drec, &ifaces, &rec_list);
Mike Christie 3949e1
+	if (rc) {
Mike Christie 3949e1
+		log_error("%s: Could not determine target nodes from firmware "
Mike Christie 3949e1
+			  "(err %d).\n", __func__, rc);
Mike Christie 3949e1
+		goto leave;
Mike Christie 3949e1
+	}
Mike Christie 3949e1
+
Mike Christie 3949e1
+	int node_count = 0;
Mike Christie 3949e1
+	struct list_head *pos;
Mike Christie 3949e1
+	list_for_each(pos, &rec_list) {
Mike Christie 3949e1
+		++node_count;
Mike Christie 3949e1
+	}
Mike Christie 3949e1
+
Mike Christie 3949e1
+	struct libiscsi_node* new_nodes;
Mike Christie 3949e1
+	/* allocate enough space for all the nodes */
Mike Christie 3949e1
+	new_nodes = calloc(node_count, sizeof *new_nodes);
Mike Christie 3949e1
+	if (new_nodes == NULL) {
Mike Christie 3949e1
+		rc = ENOMEM;
Mike Christie 3949e1
+		log_error("%s: %s.\n", __func__, strerror(ENOMEM));
Mike Christie 3949e1
+		goto leave;
Mike Christie 3949e1
+	}
Mike Christie 3949e1
+
Mike Christie 3949e1
+	struct node_rec *rec;
Mike Christie 3949e1
+	struct libiscsi_node *new_node = new_nodes;
Mike Christie 3949e1
+	/* in one loop, add nodes to idbm and create libiscsi_node entries */
Mike Christie 3949e1
+	list_for_each_entry(rec, &rec_list, list) {
Mike Christie 3949e1
+		CHECK(idbm_add_node(rec, NULL, 1 /* overwrite */));
Mike Christie 3949e1
+
Mike Christie 3949e1
+		strlcpy(new_node->name, rec->name, LIBISCSI_VALUE_MAXLEN);
Mike Christie 3949e1
+		new_node->tpgt = rec->tpgt;
Mike Christie 3949e1
+		strlcpy(new_node->address, rec->conn[0].address, NI_MAXHOST);
Mike Christie 3949e1
+		new_node->port = rec->conn[0].port;
Mike Christie 3949e1
+		strlcpy(new_node->iface, rec->iface.name, LIBISCSI_VALUE_MAXLEN);
Mike Christie 3949e1
+
Mike Christie 3949e1
+		++new_node;
Mike Christie 3949e1
+	}
5ebdd5
+
Mike Christie 3949e1
+	/* update output parameters */
Mike Christie 3949e1
+	if (nr_found) {
Mike Christie 3949e1
+		*nr_found = node_count;
Mike Christie 3949e1
+	}
5ebdd5
+	if (found_nodes) {
Mike Christie 3949e1
+		*found_nodes = new_nodes;
5ebdd5
+	}
5ebdd5
+
5ebdd5
+leave:
Mike Christie 3949e1
+	fw_free_targets(&targets);
Mike Christie 3949e1
+
Mike Christie 3949e1
+	free_iface_list(&ifaces);
Mike Christie 3949e1
+	free_rec_list(&rec_list);
Mike Christie 3949e1
+
5ebdd5
+	return rc;
5ebdd5
+}
5ebdd5
+
5ebdd5
+int libiscsi_verify_auth_info(struct libiscsi_context *context,
5ebdd5
+	const struct libiscsi_auth_info *auth_info)
5ebdd5
+{
5ebdd5
+	switch(auth_info ? auth_info->method : libiscsi_auth_none) {
5ebdd5
+	case libiscsi_auth_none:
5ebdd5
+		break;
5ebdd5
+	case libiscsi_auth_chap:
5ebdd5
+		if (!auth_info->chap.username[0]) {
5ebdd5
+			strcpy(context->error_str, "Empty username");
5ebdd5
+			return EINVAL;
5ebdd5
+		}
5ebdd5
+		if (!auth_info->chap.password[0]) {
5ebdd5
+			strcpy(context->error_str, "Empty password");
5ebdd5
+			return EINVAL;
5ebdd5
+		}
5ebdd5
+		if (auth_info->chap.reverse_username[0] &&
5ebdd5
+		    !auth_info->chap.reverse_password[0]) {
5ebdd5
+			strcpy(context->error_str, "Empty reverse password");
5ebdd5
+		    	return EINVAL;
5ebdd5
+		}
5ebdd5
+		break;
5ebdd5
+	default:
5ebdd5
+		sprintf(context->error_str,
5ebdd5
+			"Invalid authentication method: %d",
5ebdd5
+			(int)auth_info->method);
5ebdd5
+		return EINVAL;
5ebdd5
+	}
5ebdd5
+	return 0;
5ebdd5
+}
5ebdd5
+
5ebdd5
+int libiscsi_node_set_auth(struct libiscsi_context *context,
5ebdd5
+    const struct libiscsi_node *node,
5ebdd5
+    const struct libiscsi_auth_info *auth_info)
5ebdd5
+{
5ebdd5
+	int rc = 0;
5ebdd5
+
5ebdd5
+	CHECK(libiscsi_verify_auth_info(context, auth_info))
5ebdd5
+
5ebdd5
+	switch(auth_info ? auth_info->method : libiscsi_auth_none) {
5ebdd5
+	case libiscsi_auth_none:
5ebdd5
+		CHECK(libiscsi_node_set_parameter(context, node,
5ebdd5
+			"node.session.auth.authmethod", "None"))
5ebdd5
+		CHECK(libiscsi_node_set_parameter(context, node,
5ebdd5
+			"node.session.auth.username", ""))
5ebdd5
+		CHECK(libiscsi_node_set_parameter(context, node,
5ebdd5
+			"node.session.auth.password", ""))
5ebdd5
+		CHECK(libiscsi_node_set_parameter(context, node,
5ebdd5
+			"node.session.auth.username_in", ""))
5ebdd5
+		CHECK(libiscsi_node_set_parameter(context, node,
5ebdd5
+			"node.session.auth.password_in", ""))
5ebdd5
+		break;
5ebdd5
+
5ebdd5
+	case libiscsi_auth_chap:
5ebdd5
+		CHECK(libiscsi_node_set_parameter(context, node,
5ebdd5
+			"node.session.auth.authmethod", "CHAP"))
5ebdd5
+		CHECK(libiscsi_node_set_parameter(context, node,
5ebdd5
+			"node.session.auth.username",
5ebdd5
+			auth_info->chap.username))
5ebdd5
+		CHECK(libiscsi_node_set_parameter(context, node,
5ebdd5
+			"node.session.auth.password",
5ebdd5
+			auth_info->chap.password))
5ebdd5
+		CHECK(libiscsi_node_set_parameter(context, node,
5ebdd5
+			"node.session.auth.username_in",
5ebdd5
+			auth_info->chap.reverse_username))
5ebdd5
+		CHECK(libiscsi_node_set_parameter(context, node,
5ebdd5
+			"node.session.auth.password_in",
5ebdd5
+			auth_info->chap.reverse_password))
5ebdd5
+		break;
5ebdd5
+	}
5ebdd5
+leave:
5ebdd5
+	return rc;
5ebdd5
+}
5ebdd5
+
5ebdd5
+int libiscsi_node_get_auth(struct libiscsi_context *context,
5ebdd5
+    const struct libiscsi_node *node,
5ebdd5
+    struct libiscsi_auth_info *auth_info)
5ebdd5
+{
5ebdd5
+	int rc = 0;
5ebdd5
+	char value[LIBISCSI_VALUE_MAXLEN];
5ebdd5
+
5ebdd5
+	memset(auth_info, 0, sizeof *auth_info);
5ebdd5
+
5ebdd5
+	CHECK(libiscsi_node_get_parameter(context, node,
5ebdd5
+			"node.session.auth.authmethod", value))
5ebdd5
+
5ebdd5
+	if (!strcmp(value, "None")) {
5ebdd5
+		auth_info->method = libiscsi_auth_none;
5ebdd5
+	} else if (!strcmp(value, "CHAP")) {
5ebdd5
+		auth_info->method = libiscsi_auth_chap;
5ebdd5
+		CHECK(libiscsi_node_get_parameter(context, node,
5ebdd5
+			"node.session.auth.username",
5ebdd5
+			auth_info->chap.username))
5ebdd5
+		CHECK(libiscsi_node_get_parameter(context, node,
5ebdd5
+			"node.session.auth.password",
5ebdd5
+			auth_info->chap.password))
5ebdd5
+		CHECK(libiscsi_node_get_parameter(context, node,
5ebdd5
+			"node.session.auth.username_in",
5ebdd5
+			auth_info->chap.reverse_username))
5ebdd5
+		CHECK(libiscsi_node_get_parameter(context, node,
5ebdd5
+			"node.session.auth.password_in",
5ebdd5
+			auth_info->chap.reverse_password))
5ebdd5
+	} else {
5ebdd5
+		snprintf(context->error_str, sizeof(context->error_str),
5ebdd5
+			 "unknown authentication method: %s", value);
5ebdd5
+		rc = EINVAL;
5ebdd5
+	}
5ebdd5
+leave:
5ebdd5
+	return rc;
5ebdd5
+}
5ebdd5
+
5ebdd5
+static void node_to_rec(const struct libiscsi_node *node,
5ebdd5
+	struct node_rec *rec)
5ebdd5
+{
5ebdd5
+	memset(rec, 0, sizeof *rec);
5ebdd5
+	idbm_node_setup_defaults(rec);
5ebdd5
+	strlcpy(rec->name, node->name, TARGET_NAME_MAXLEN);
5ebdd5
+	rec->tpgt = node->tpgt;
5ebdd5
+	strlcpy(rec->conn[0].address, node->address, NI_MAXHOST);
5ebdd5
+	rec->conn[0].port = node->port;
5ebdd5
+}
5ebdd5
+
5ebdd5
+int login_helper(void *data, node_rec_t *rec)
5ebdd5
+{
Mike Christie 3949e1
+	char *iface = (char*)data;
Mike Christie 3949e1
+	if (strcmp(iface, rec->iface.name))
Mike Christie 3949e1
+		/* different iface, skip it */
Mike Christie 3949e1
+		return -1;
Mike Christie 3949e1
+
5ebdd5
+	int rc = iscsid_req_by_rec(MGMT_IPC_SESSION_LOGIN, rec);
5ebdd5
+	if (rc) {
Mike Christie 3949e1
+		iscsi_err_print_msg(rc);
5ebdd5
+		rc = ENOTCONN;
5ebdd5
+	}
5ebdd5
+	return rc;
5ebdd5
+}
5ebdd5
+
5ebdd5
+int libiscsi_node_login(struct libiscsi_context *context,
5ebdd5
+	const struct libiscsi_node *node)
5ebdd5
+{
5ebdd5
+	int nr_found = 0, rc;
5ebdd5
+
Mike Christie 3949e1
+	CHECK(idbm_for_each_iface(&nr_found, (void*)node->iface, login_helper,
5ebdd5
+		(char *)node->name, node->tpgt,
5ebdd5
+		(char *)node->address, node->port))
5ebdd5
+	if (nr_found == 0) {
5ebdd5
+		strcpy(context->error_str, "No such node");
5ebdd5
+		rc = ENODEV;
5ebdd5
+	}
5ebdd5
+leave:
5ebdd5
+	return rc;
5ebdd5
+}
5ebdd5
+
5ebdd5
+static int logout_helper(void *data, struct session_info *info)
5ebdd5
+{
5ebdd5
+	int rc;
5ebdd5
+	struct node_rec *rec = data;
5ebdd5
+
5ebdd5
+	if (!iscsi_match_session(rec, info))
5ebdd5
+		/* Tell iscsi_sysfs_for_each_session this session was not a
5ebdd5
+		   match so that it will not increase nr_found. */
5ebdd5
+		return -1;
5ebdd5
+
5ebdd5
+	rc = iscsid_req_by_sid(MGMT_IPC_SESSION_LOGOUT, info->sid);
5ebdd5
+	if (rc) {
Mike Christie 3949e1
+		iscsi_err_print_msg(rc);
5ebdd5
+		rc = EIO;
5ebdd5
+	}
5ebdd5
+
5ebdd5
+	return rc;
5ebdd5
+}
5ebdd5
+
5ebdd5
+int libiscsi_node_logout(struct libiscsi_context *context,
5ebdd5
+	const struct libiscsi_node *node)
5ebdd5
+{
5ebdd5
+	int nr_found = 0, rc;
5ebdd5
+	struct node_rec rec;
5ebdd5
+
5ebdd5
+	node_to_rec(node, &rec);
c2d5d2
+	CHECK(iscsi_sysfs_for_each_session(&rec, &nr_found, logout_helper,0))
5ebdd5
+	if (nr_found == 0) {
5ebdd5
+		strcpy(context->error_str, "No matching session");
5ebdd5
+		rc = ENODEV;
5ebdd5
+	}
5ebdd5
+leave:
5ebdd5
+	return rc;
5ebdd5
+}
5ebdd5
+
5ebdd5
+int libiscsi_node_set_parameter(struct libiscsi_context *context,
5ebdd5
+	const struct libiscsi_node *node,
5ebdd5
+	const char *parameter, const char *value)
5ebdd5
+{
5ebdd5
+	int nr_found = 0, rc;
0e55d5
+	struct user_param *param;
0e55d5
+	struct list_head params;
0e55d5
+
0e55d5
+	INIT_LIST_HEAD(¶ms);
0e55d5
+	param = idbm_alloc_user_param(parameter, value);
0e55d5
+	if (!param) {
0e55d5
+		rc = ENOMEM;
0e55d5
+		goto leave;
0e55d5
+	}
0e55d5
+	list_add_tail(¶ms, ¶m->list);
5ebdd5
+
0e55d5
+	CHECK(idbm_for_each_iface(&nr_found, ¶ms, idbm_node_set_param,
5ebdd5
+		(char *)node->name, node->tpgt,
5ebdd5
+		(char *)node->address, node->port))
5ebdd5
+	if (nr_found == 0) {
5ebdd5
+		strcpy(context->error_str, "No such node");
5ebdd5
+		rc = ENODEV;
5ebdd5
+	}
0e55d5
+	free(param->name);
0e55d5
+	free(param);
5ebdd5
+leave:
5ebdd5
+	return rc;
5ebdd5
+}
5ebdd5
+
5ebdd5
+static int get_parameter_helper(void *data, node_rec_t *rec)
5ebdd5
+{
5ebdd5
+	struct libiscsi_context *context = data;
5ebdd5
+	recinfo_t *info;
5ebdd5
+	int i;
5ebdd5
+
5ebdd5
+	info = idbm_recinfo_alloc(MAX_KEYS);
5ebdd5
+	if (!info) {
5ebdd5
+		snprintf(context->error_str, sizeof(context->error_str),
5ebdd5
+			 strerror(ENOMEM));
5ebdd5
+		return ENOMEM;
5ebdd5
+	}
5ebdd5
+
5ebdd5
+	idbm_recinfo_node(rec, info);
5ebdd5
+
5ebdd5
+	for (i = 0; i < MAX_KEYS; i++) {
5ebdd5
+		if (!info[i].visible)
5ebdd5
+			continue;
5ebdd5
+
5ebdd5
+		if (strcmp(context->parameter, info[i].name))
5ebdd5
+			continue;
5ebdd5
+
5ebdd5
+		strlcpy(context->value, info[i].value, LIBISCSI_VALUE_MAXLEN);
5ebdd5
+		break;
5ebdd5
+	}
5ebdd5
+
5ebdd5
+	free(info);
5ebdd5
+
5ebdd5
+	if (i == MAX_KEYS) {
5ebdd5
+		strcpy(context->error_str, "No such parameter");
5ebdd5
+		return EINVAL;
5ebdd5
+	}
5ebdd5
+
5ebdd5
+	return 0;
5ebdd5
+}
5ebdd5
+
5ebdd5
+int libiscsi_node_get_parameter(struct libiscsi_context *context,
5ebdd5
+	const struct libiscsi_node *node, const char *parameter, char *value)
5ebdd5
+{
5ebdd5
+	int nr_found = 0, rc = 0;
5ebdd5
+
5ebdd5
+	context->parameter = parameter;
5ebdd5
+	context->value = value;
5ebdd5
+
5ebdd5
+	/* Note we assume there is only one interface, if not we will get
5ebdd5
+	   the value from the last interface iterated over!
5ebdd5
+	   This (multiple interfaces) can only happen if someone explicitly
5ebdd5
+	   created ones using iscsiadm. Even then this should not be a problem
5ebdd5
+	   as most settings should be the same independent of the iface. */
5ebdd5
+	CHECK(idbm_for_each_iface(&nr_found, context, get_parameter_helper,
5ebdd5
+		(char *)node->name, node->tpgt,
5ebdd5
+		(char *)node->address, node->port))
5ebdd5
+	if (nr_found == 0) {
5ebdd5
+		strcpy(context->error_str, "No such node");
5ebdd5
+		rc = ENODEV;
5ebdd5
+	}
5ebdd5
+leave:
5ebdd5
+	return rc;
5ebdd5
+}
5ebdd5
+
5ebdd5
+const char *libiscsi_get_error_string(struct libiscsi_context *context)
5ebdd5
+{
5ebdd5
+	/* Sometimes the core open-iscsi code does not give us an error
5ebdd5
+	   message */
5ebdd5
+	if (!context->error_str[0])
5ebdd5
+		return "Unknown error";
5ebdd5
+
5ebdd5
+	return context->error_str;
5ebdd5
+}
5ebdd5
+
5ebdd5
+
5ebdd5
+/************************** Utility functions *******************************/
5ebdd5
+
5ebdd5
+int libiscsi_get_firmware_network_config(
5ebdd5
+    struct libiscsi_network_config *config)
5ebdd5
+{
5ebdd5
+	struct boot_context fw_entry;
5ebdd5
+
Mike Christie 3949e1
+	if (!sysfs_initialized) {
Mike Christie 3949e1
+		sysfs_init();
Mike Christie 3949e1
+		sysfs_initialized = 1;
Mike Christie 3949e1
+	}
Mike Christie 3949e1
+
5ebdd5
+	memset(config, 0, sizeof *config);
5ebdd5
+	memset(&fw_entry, 0, sizeof fw_entry);
5ebdd5
+	if (fw_get_entry(&fw_entry))
5ebdd5
+		return ENODEV;
5ebdd5
+
5ebdd5
+	config->dhcp = strlen(fw_entry.dhcp) ? 1 : 0;
278948
+	strlcpy(config->iface_name, fw_entry.iface, LIBISCSI_VALUE_MAXLEN);
278948
+	strlcpy(config->mac_address, fw_entry.mac, LIBISCSI_VALUE_MAXLEN);
278948
+	strlcpy(config->ip_address, fw_entry.ipaddr, LIBISCSI_VALUE_MAXLEN);
278948
+	strlcpy(config->netmask, fw_entry.mask, LIBISCSI_VALUE_MAXLEN);
278948
+	strlcpy(config->gateway, fw_entry.gateway, LIBISCSI_VALUE_MAXLEN);
278948
+	strlcpy(config->primary_dns, fw_entry.primary_dns, LIBISCSI_VALUE_MAXLEN);
278948
+	strlcpy(config->secondary_dns, fw_entry.secondary_dns, LIBISCSI_VALUE_MAXLEN);
5ebdd5
+	return 0;
5ebdd5
+}
5ebdd5
+
5ebdd5
+int libiscsi_get_firmware_initiator_name(char *initiatorname)
5ebdd5
+{
5ebdd5
+	struct boot_context fw_entry;
5ebdd5
+
Mike Christie 3949e1
+	if (!sysfs_initialized) {
Mike Christie 3949e1
+		sysfs_init();
Mike Christie 3949e1
+		sysfs_initialized = 1;
Mike Christie 3949e1
+	}
Mike Christie 3949e1
+
5ebdd5
+	memset(initiatorname, 0, LIBISCSI_VALUE_MAXLEN);
5ebdd5
+	memset(&fw_entry, 0, sizeof fw_entry);
5ebdd5
+	if (fw_get_entry(&fw_entry))
5ebdd5
+		return ENODEV;
5ebdd5
+
278948
+	strlcpy(initiatorname, fw_entry.initiatorname, LIBISCSI_VALUE_MAXLEN);
5ebdd5
+
5ebdd5
+	return 0;
5ebdd5
+}
0e55d5
diff --git a/libiscsi/libiscsi.doxy b/libiscsi/libiscsi.doxy
0e55d5
new file mode 100644
278948
index 0000000..7a5ff7f
0e55d5
--- /dev/null
0e55d5
+++ b/libiscsi/libiscsi.doxy
5ebdd5
@@ -0,0 +1,1473 @@
5ebdd5
+# Doxyfile 1.5.7.1
5ebdd5
+
5ebdd5
+# This file describes the settings to be used by the documentation system
5ebdd5
+# doxygen (www.doxygen.org) for a project
5ebdd5
+#
5ebdd5
+# All text after a hash (#) is considered a comment and will be ignored
5ebdd5
+# The format is:
5ebdd5
+#       TAG = value [value, ...]
5ebdd5
+# For lists items can also be appended using:
5ebdd5
+#       TAG += value [value, ...]
5ebdd5
+# Values that contain spaces should be placed between quotes (" ")
5ebdd5
+
5ebdd5
+#---------------------------------------------------------------------------
5ebdd5
+# Project related configuration options
5ebdd5
+#---------------------------------------------------------------------------
5ebdd5
+
5ebdd5
+# This tag specifies the encoding used for all characters in the config file 
5ebdd5
+# that follow. The default is UTF-8 which is also the encoding used for all 
5ebdd5
+# text before the first occurrence of this tag. Doxygen uses libiconv (or the 
5ebdd5
+# iconv built into libc) for the transcoding. See 
5ebdd5
+# http://www.gnu.org/software/libiconv for the list of possible encodings.
5ebdd5
+
5ebdd5
+DOXYFILE_ENCODING      = UTF-8
5ebdd5
+
5ebdd5
+# The PROJECT_NAME tag is a single word (or a sequence of words surrounded 
5ebdd5
+# by quotes) that should identify the project.
5ebdd5
+
5ebdd5
+PROJECT_NAME           = libiscsi
5ebdd5
+
5ebdd5
+# The PROJECT_NUMBER tag can be used to enter a project or revision number. 
5ebdd5
+# This could be handy for archiving the generated documentation or 
5ebdd5
+# if some version control system is used.
5ebdd5
+
5ebdd5
+PROJECT_NUMBER         = 
5ebdd5
+
5ebdd5
+# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) 
5ebdd5
+# base path where the generated documentation will be put. 
5ebdd5
+# If a relative path is entered, it will be relative to the location 
5ebdd5
+# where doxygen was started. If left blank the current directory will be used.
5ebdd5
+
5ebdd5
+OUTPUT_DIRECTORY       = 
5ebdd5
+
5ebdd5
+# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 
5ebdd5
+# 4096 sub-directories (in 2 levels) under the output directory of each output 
5ebdd5
+# format and will distribute the generated files over these directories. 
5ebdd5
+# Enabling this option can be useful when feeding doxygen a huge amount of 
5ebdd5
+# source files, where putting all generated files in the same directory would 
5ebdd5
+# otherwise cause performance problems for the file system.
5ebdd5
+
5ebdd5
+CREATE_SUBDIRS         = NO
5ebdd5
+
5ebdd5
+# The OUTPUT_LANGUAGE tag is used to specify the language in which all 
5ebdd5
+# documentation generated by doxygen is written. Doxygen will use this 
5ebdd5
+# information to generate all constant output in the proper language. 
5ebdd5
+# The default language is English, other supported languages are: 
5ebdd5
+# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, 
5ebdd5
+# Croatian, Czech, Danish, Dutch, Farsi, Finnish, French, German, Greek, 
5ebdd5
+# Hungarian, Italian, Japanese, Japanese-en (Japanese with English messages), 
5ebdd5
+# Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, Polish, 
5ebdd5
+# Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak, Slovene, 
5ebdd5
+# Spanish, Swedish, and Ukrainian.
5ebdd5
+
5ebdd5
+OUTPUT_LANGUAGE        = English
5ebdd5
+
5ebdd5
+# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will 
5ebdd5
+# include brief member descriptions after the members that are listed in 
5ebdd5
+# the file and class documentation (similar to JavaDoc). 
5ebdd5
+# Set to NO to disable this.
5ebdd5
+
5ebdd5
+BRIEF_MEMBER_DESC      = YES
5ebdd5
+
5ebdd5
+# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend 
5ebdd5
+# the brief description of a member or function before the detailed description. 
5ebdd5
+# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 
5ebdd5
+# brief descriptions will be completely suppressed.
5ebdd5
+
5ebdd5
+REPEAT_BRIEF           = NO
5ebdd5
+
5ebdd5
+# This tag implements a quasi-intelligent brief description abbreviator 
5ebdd5
+# that is used to form the text in various listings. Each string 
5ebdd5
+# in this list, if found as the leading text of the brief description, will be 
5ebdd5
+# stripped from the text and the result after processing the whole list, is 
5ebdd5
+# used as the annotated text. Otherwise, the brief description is used as-is. 
5ebdd5
+# If left blank, the following values are used ("$name" is automatically 
5ebdd5
+# replaced with the name of the entity): "The $name class" "The $name widget" 
5ebdd5
+# "The $name file" "is" "provides" "specifies" "contains" 
5ebdd5
+# "represents" "a" "an" "the"
5ebdd5
+
5ebdd5
+ABBREVIATE_BRIEF       = 
5ebdd5
+
5ebdd5
+# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 
5ebdd5
+# Doxygen will generate a detailed section even if there is only a brief 
5ebdd5
+# description.
5ebdd5
+
5ebdd5
+ALWAYS_DETAILED_SEC    = YES
5ebdd5
+
5ebdd5
+# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all 
5ebdd5
+# inherited members of a class in the documentation of that class as if those 
5ebdd5
+# members were ordinary class members. Constructors, destructors and assignment 
5ebdd5
+# operators of the base classes will not be shown.
5ebdd5
+
5ebdd5
+INLINE_INHERITED_MEMB  = NO
5ebdd5
+
5ebdd5
+# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full 
5ebdd5
+# path before files name in the file list and in the header files. If set 
5ebdd5
+# to NO the shortest path that makes the file name unique will be used.
5ebdd5
+
5ebdd5
+FULL_PATH_NAMES        = YES
5ebdd5
+
5ebdd5
+# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag 
5ebdd5
+# can be used to strip a user-defined part of the path. Stripping is 
5ebdd5
+# only done if one of the specified strings matches the left-hand part of 
5ebdd5
+# the path. The tag can be used to show relative paths in the file list. 
5ebdd5
+# If left blank the directory from which doxygen is run is used as the 
5ebdd5
+# path to strip.
5ebdd5
+
5ebdd5
+STRIP_FROM_PATH        = 
5ebdd5
+
5ebdd5
+# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of 
5ebdd5
+# the path mentioned in the documentation of a class, which tells 
5ebdd5
+# the reader which header file to include in order to use a class. 
5ebdd5
+# If left blank only the name of the header file containing the class 
5ebdd5
+# definition is used. Otherwise one should specify the include paths that 
5ebdd5
+# are normally passed to the compiler using the -I flag.
5ebdd5
+
5ebdd5
+STRIP_FROM_INC_PATH    = 
5ebdd5
+
5ebdd5
+# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter 
5ebdd5
+# (but less readable) file names. This can be useful is your file systems 
5ebdd5
+# doesn't support long names like on DOS, Mac, or CD-ROM.
5ebdd5
+
5ebdd5
+SHORT_NAMES            = NO
5ebdd5
+
5ebdd5
+# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen 
5ebdd5
+# will interpret the first line (until the first dot) of a JavaDoc-style 
5ebdd5
+# comment as the brief description. If set to NO, the JavaDoc 
5ebdd5
+# comments will behave just like regular Qt-style comments 
5ebdd5
+# (thus requiring an explicit @brief command for a brief description.)
5ebdd5
+
5ebdd5
+JAVADOC_AUTOBRIEF      = NO
5ebdd5
+
5ebdd5
+# If the QT_AUTOBRIEF tag is set to YES then Doxygen will 
5ebdd5
+# interpret the first line (until the first dot) of a Qt-style 
5ebdd5
+# comment as the brief description. If set to NO, the comments 
5ebdd5
+# will behave just like regular Qt-style comments (thus requiring 
5ebdd5
+# an explicit \brief command for a brief description.)
5ebdd5
+
5ebdd5
+QT_AUTOBRIEF           = NO
5ebdd5
+
5ebdd5
+# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen 
5ebdd5
+# treat a multi-line C++ special comment block (i.e. a block of //! or /// 
5ebdd5
+# comments) as a brief description. This used to be the default behaviour. 
5ebdd5
+# The new default is to treat a multi-line C++ comment block as a detailed 
5ebdd5
+# description. Set this tag to YES if you prefer the old behaviour instead.
5ebdd5
+
5ebdd5
+MULTILINE_CPP_IS_BRIEF = NO
5ebdd5
+
5ebdd5
+# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented 
5ebdd5
+# member inherits the documentation from any documented member that it 
5ebdd5
+# re-implements.
5ebdd5
+
5ebdd5
+INHERIT_DOCS           = YES
5ebdd5
+
5ebdd5
+# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce 
5ebdd5
+# a new page for each member. If set to NO, the documentation of a member will 
5ebdd5
+# be part of the file/class/namespace that contains it.
5ebdd5
+
5ebdd5
+SEPARATE_MEMBER_PAGES  = NO
5ebdd5
+
5ebdd5
+# The TAB_SIZE tag can be used to set the number of spaces in a tab. 
5ebdd5
+# Doxygen uses this value to replace tabs by spaces in code fragments.
5ebdd5
+
5ebdd5
+TAB_SIZE               = 8
5ebdd5
+
5ebdd5
+# This tag can be used to specify a number of aliases that acts 
5ebdd5
+# as commands in the documentation. An alias has the form "name=value". 
5ebdd5
+# For example adding "sideeffect=\par Side Effects:\n" will allow you to 
5ebdd5
+# put the command \sideeffect (or @sideeffect) in the documentation, which 
5ebdd5
+# will result in a user-defined paragraph with heading "Side Effects:". 
5ebdd5
+# You can put \n's in the value part of an alias to insert newlines.
5ebdd5
+
5ebdd5
+ALIASES                = 
5ebdd5
+
5ebdd5
+# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C 
5ebdd5
+# sources only. Doxygen will then generate output that is more tailored for C. 
5ebdd5
+# For instance, some of the names that are used will be different. The list 
5ebdd5
+# of all members will be omitted, etc.
5ebdd5
+
5ebdd5
+OPTIMIZE_OUTPUT_FOR_C  = YES
5ebdd5
+
5ebdd5
+# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java 
5ebdd5
+# sources only. Doxygen will then generate output that is more tailored for 
5ebdd5
+# Java. For instance, namespaces will be presented as packages, qualified 
5ebdd5
+# scopes will look different, etc.
5ebdd5
+
5ebdd5
+OPTIMIZE_OUTPUT_JAVA   = NO
5ebdd5
+
5ebdd5
+# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran 
5ebdd5
+# sources only. Doxygen will then generate output that is more tailored for 
5ebdd5
+# Fortran.
5ebdd5
+
5ebdd5
+OPTIMIZE_FOR_FORTRAN   = NO
5ebdd5
+
5ebdd5
+# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL 
5ebdd5
+# sources. Doxygen will then generate output that is tailored for 
5ebdd5
+# VHDL.
5ebdd5
+
5ebdd5
+OPTIMIZE_OUTPUT_VHDL   = NO
5ebdd5
+
5ebdd5
+# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want 
5ebdd5
+# to include (a tag file for) the STL sources as input, then you should 
5ebdd5
+# set this tag to YES in order to let doxygen match functions declarations and 
5ebdd5
+# definitions whose arguments contain STL classes (e.g. func(std::string); v.s. 
5ebdd5
+# func(std::string) {}). This also make the inheritance and collaboration 
5ebdd5
+# diagrams that involve STL classes more complete and accurate.
5ebdd5
+
5ebdd5
+BUILTIN_STL_SUPPORT    = NO
5ebdd5
+
5ebdd5
+# If you use Microsoft's C++/CLI language, you should set this option to YES to
5ebdd5
+# enable parsing support.
5ebdd5
+
5ebdd5
+CPP_CLI_SUPPORT        = NO
5ebdd5
+
5ebdd5
+# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. 
5ebdd5
+# Doxygen will parse them like normal C++ but will assume all classes use public 
5ebdd5
+# instead of private inheritance when no explicit protection keyword is present.
5ebdd5
+
5ebdd5
+SIP_SUPPORT            = NO
5ebdd5
+
5ebdd5
+# For Microsoft's IDL there are propget and propput attributes to indicate getter 
5ebdd5
+# and setter methods for a property. Setting this option to YES (the default) 
5ebdd5
+# will make doxygen to replace the get and set methods by a property in the 
5ebdd5
+# documentation. This will only work if the methods are indeed getting or 
5ebdd5
+# setting a simple type. If this is not the case, or you want to show the 
5ebdd5
+# methods anyway, you should set this option to NO.
5ebdd5
+
5ebdd5
+IDL_PROPERTY_SUPPORT   = YES
5ebdd5
+
5ebdd5
+# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 
5ebdd5
+# tag is set to YES, then doxygen will reuse the documentation of the first 
5ebdd5
+# member in the group (if any) for the other members of the group. By default 
5ebdd5
+# all members of a group must be documented explicitly.
5ebdd5
+
5ebdd5
+DISTRIBUTE_GROUP_DOC   = NO
5ebdd5
+
5ebdd5
+# Set the SUBGROUPING tag to YES (the default) to allow class member groups of 
5ebdd5
+# the same type (for instance a group of public functions) to be put as a 
5ebdd5
+# subgroup of that type (e.g. under the Public Functions section). Set it to 
5ebdd5
+# NO to prevent subgrouping. Alternatively, this can be done per class using 
5ebdd5
+# the \nosubgrouping command.
5ebdd5
+
5ebdd5
+SUBGROUPING            = YES
5ebdd5
+
5ebdd5
+# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum 
5ebdd5
+# is documented as struct, union, or enum with the name of the typedef. So 
5ebdd5
+# typedef struct TypeS {} TypeT, will appear in the documentation as a struct 
5ebdd5
+# with name TypeT. When disabled the typedef will appear as a member of a file, 
5ebdd5
+# namespace, or class. And the struct will be named TypeS. This can typically 
5ebdd5
+# be useful for C code in case the coding convention dictates that all compound 
5ebdd5
+# types are typedef'ed and only the typedef is referenced, never the tag name.
5ebdd5
+
5ebdd5
+TYPEDEF_HIDES_STRUCT   = NO
5ebdd5
+
5ebdd5
+# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to 
5ebdd5
+# determine which symbols to keep in memory and which to flush to disk.
5ebdd5
+# When the cache is full, less often used symbols will be written to disk.
5ebdd5
+# For small to medium size projects (<1000 input files) the default value is 
5ebdd5
+# probably good enough. For larger projects a too small cache size can cause 
5ebdd5
+# doxygen to be busy swapping symbols to and from disk most of the time 
5ebdd5
+# causing a significant performance penality. 
5ebdd5
+# If the system has enough physical memory increasing the cache will improve the 
5ebdd5
+# performance by keeping more symbols in memory. Note that the value works on 
5ebdd5
+# a logarithmic scale so increasing the size by one will rougly double the 
5ebdd5
+# memory usage. The cache size is given by this formula: 
5ebdd5
+# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0, 
5ebdd5
+# corresponding to a cache size of 2^16 = 65536 symbols
5ebdd5
+
5ebdd5
+SYMBOL_CACHE_SIZE      = 0
5ebdd5
+
5ebdd5
+#---------------------------------------------------------------------------
5ebdd5
+# Build related configuration options
5ebdd5
+#---------------------------------------------------------------------------
5ebdd5
+
5ebdd5
+# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in 
5ebdd5
+# documentation are documented, even if no documentation was available. 
5ebdd5
+# Private class members and static file members will be hidden unless 
5ebdd5
+# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
5ebdd5
+
5ebdd5
+EXTRACT_ALL            = YES
5ebdd5
+
5ebdd5
+# If the EXTRACT_PRIVATE tag is set to YES all private members of a class 
5ebdd5
+# will be included in the documentation.
5ebdd5
+
5ebdd5
+EXTRACT_PRIVATE        = NO
5ebdd5
+
5ebdd5
+# If the EXTRACT_STATIC tag is set to YES all static members of a file 
5ebdd5
+# will be included in the documentation.
5ebdd5
+
5ebdd5
+EXTRACT_STATIC         = NO
5ebdd5
+
5ebdd5
+# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) 
5ebdd5
+# defined locally in source files will be included in the documentation. 
5ebdd5
+# If set to NO only classes defined in header files are included.
5ebdd5
+
5ebdd5
+EXTRACT_LOCAL_CLASSES  = YES
5ebdd5
+
5ebdd5
+# This flag is only useful for Objective-C code. When set to YES local 
5ebdd5
+# methods, which are defined in the implementation section but not in 
5ebdd5
+# the interface are included in the documentation. 
5ebdd5
+# If set to NO (the default) only methods in the interface are included.
5ebdd5
+
5ebdd5
+EXTRACT_LOCAL_METHODS  = NO
5ebdd5
+
5ebdd5
+# If this flag is set to YES, the members of anonymous namespaces will be 
5ebdd5
+# extracted and appear in the documentation as a namespace called 
5ebdd5
+# 'anonymous_namespace{file}', where file will be replaced with the base 
5ebdd5
+# name of the file that contains the anonymous namespace. By default 
5ebdd5
+# anonymous namespace are hidden.
5ebdd5
+
5ebdd5
+EXTRACT_ANON_NSPACES   = NO
5ebdd5
+
5ebdd5
+# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all 
5ebdd5
+# undocumented members of documented classes, files or namespaces. 
5ebdd5
+# If set to NO (the default) these members will be included in the 
5ebdd5
+# various overviews, but no documentation section is generated. 
5ebdd5
+# This option has no effect if EXTRACT_ALL is enabled.
5ebdd5
+
5ebdd5
+HIDE_UNDOC_MEMBERS     = NO
5ebdd5
+
5ebdd5
+# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all 
5ebdd5
+# undocumented classes that are normally visible in the class hierarchy. 
5ebdd5
+# If set to NO (the default) these classes will be included in the various 
5ebdd5
+# overviews. This option has no effect if EXTRACT_ALL is enabled.
5ebdd5
+
5ebdd5
+HIDE_UNDOC_CLASSES     = NO
5ebdd5
+
5ebdd5
+# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all 
5ebdd5
+# friend (class|struct|union) declarations. 
5ebdd5
+# If set to NO (the default) these declarations will be included in the 
5ebdd5
+# documentation.
5ebdd5
+
5ebdd5
+HIDE_FRIEND_COMPOUNDS  = NO
5ebdd5
+
5ebdd5
+# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any 
5ebdd5
+# documentation blocks found inside the body of a function. 
5ebdd5
+# If set to NO (the default) these blocks will be appended to the 
5ebdd5
+# function's detailed documentation block.
5ebdd5
+
5ebdd5
+HIDE_IN_BODY_DOCS      = NO
5ebdd5
+
5ebdd5
+# The INTERNAL_DOCS tag determines if documentation 
5ebdd5
+# that is typed after a \internal command is included. If the tag is set 
5ebdd5
+# to NO (the default) then the documentation will be excluded. 
5ebdd5
+# Set it to YES to include the internal documentation.
5ebdd5
+
5ebdd5
+INTERNAL_DOCS          = NO
5ebdd5
+
5ebdd5
+# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate 
5ebdd5
+# file names in lower-case letters. If set to YES upper-case letters are also 
5ebdd5
+# allowed. This is useful if you have classes or files whose names only differ 
5ebdd5
+# in case and if your file system supports case sensitive file names. Windows 
5ebdd5
+# and Mac users are advised to set this option to NO.
5ebdd5
+
5ebdd5
+CASE_SENSE_NAMES       = YES
5ebdd5
+
5ebdd5
+# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen 
5ebdd5
+# will show members with their full class and namespace scopes in the 
5ebdd5
+# documentation. If set to YES the scope will be hidden.
5ebdd5
+
5ebdd5
+HIDE_SCOPE_NAMES       = NO
5ebdd5
+
5ebdd5
+# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen 
5ebdd5
+# will put a list of the files that are included by a file in the documentation 
5ebdd5
+# of that file.
5ebdd5
+
5ebdd5
+SHOW_INCLUDE_FILES     = YES
5ebdd5
+
5ebdd5
+# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] 
5ebdd5
+# is inserted in the documentation for inline members.
5ebdd5
+
5ebdd5
+INLINE_INFO            = YES
5ebdd5
+
5ebdd5
+# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen 
5ebdd5
+# will sort the (detailed) documentation of file and class members 
5ebdd5
+# alphabetically by member name. If set to NO the members will appear in 
5ebdd5
+# declaration order.
5ebdd5
+
5ebdd5
+SORT_MEMBER_DOCS       = YES
5ebdd5
+
5ebdd5
+# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the 
5ebdd5
+# brief documentation of file, namespace and class members alphabetically 
5ebdd5
+# by member name. If set to NO (the default) the members will appear in 
5ebdd5
+# declaration order.
5ebdd5
+
5ebdd5
+SORT_BRIEF_DOCS        = NO
5ebdd5
+
5ebdd5
+# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the 
5ebdd5
+# hierarchy of group names into alphabetical order. If set to NO (the default) 
5ebdd5
+# the group names will appear in their defined order.
5ebdd5
+
5ebdd5
+SORT_GROUP_NAMES       = NO
5ebdd5
+
5ebdd5
+# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be 
5ebdd5
+# sorted by fully-qualified names, including namespaces. If set to 
5ebdd5
+# NO (the default), the class list will be sorted only by class name, 
5ebdd5
+# not including the namespace part. 
5ebdd5
+# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
5ebdd5
+# Note: This option applies only to the class list, not to the 
5ebdd5
+# alphabetical list.
5ebdd5
+
5ebdd5
+SORT_BY_SCOPE_NAME     = NO
5ebdd5
+
5ebdd5
+# The GENERATE_TODOLIST tag can be used to enable (YES) or 
5ebdd5
+# disable (NO) the todo list. This list is created by putting \todo 
5ebdd5
+# commands in the documentation.
5ebdd5
+
5ebdd5
+GENERATE_TODOLIST      = YES
5ebdd5
+
5ebdd5
+# The GENERATE_TESTLIST tag can be used to enable (YES) or 
5ebdd5
+# disable (NO) the test list. This list is created by putting \test 
5ebdd5
+# commands in the documentation.
5ebdd5
+
5ebdd5
+GENERATE_TESTLIST      = YES
5ebdd5
+
5ebdd5
+# The GENERATE_BUGLIST tag can be used to enable (YES) or 
5ebdd5
+# disable (NO) the bug list. This list is created by putting \bug 
5ebdd5
+# commands in the documentation.
5ebdd5
+
5ebdd5
+GENERATE_BUGLIST       = YES
5ebdd5
+
5ebdd5
+# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or 
5ebdd5
+# disable (NO) the deprecated list. This list is created by putting 
5ebdd5
+# \deprecated commands in the documentation.
5ebdd5
+
5ebdd5
+GENERATE_DEPRECATEDLIST= YES
5ebdd5
+
5ebdd5
+# The ENABLED_SECTIONS tag can be used to enable conditional 
5ebdd5
+# documentation sections, marked by \if sectionname ... \endif.
5ebdd5
+
5ebdd5
+ENABLED_SECTIONS       = 
5ebdd5
+
5ebdd5
+# The MAX_INITIALIZER_LINES tag determines the maximum number of lines 
5ebdd5
+# the initial value of a variable or define consists of for it to appear in 
5ebdd5
+# the documentation. If the initializer consists of more lines than specified 
5ebdd5
+# here it will be hidden. Use a value of 0 to hide initializers completely. 
5ebdd5
+# The appearance of the initializer of individual variables and defines in the 
5ebdd5
+# documentation can be controlled using \showinitializer or \hideinitializer 
5ebdd5
+# command in the documentation regardless of this setting.
5ebdd5
+
5ebdd5
+MAX_INITIALIZER_LINES  = 30
5ebdd5
+
5ebdd5
+# Set the SHOW_USED_FILES tag to NO to disable the list of files generated 
5ebdd5
+# at the bottom of the documentation of classes and structs. If set to YES the 
5ebdd5
+# list will mention the files that were used to generate the documentation.
5ebdd5
+
5ebdd5
+SHOW_USED_FILES        = YES
5ebdd5
+
5ebdd5
+# If the sources in your project are distributed over multiple directories 
5ebdd5
+# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy 
5ebdd5
+# in the documentation. The default is NO.
5ebdd5
+
5ebdd5
+SHOW_DIRECTORIES       = NO
5ebdd5
+
5ebdd5
+# Set the SHOW_FILES tag to NO to disable the generation of the Files page.
5ebdd5
+# This will remove the Files entry from the Quick Index and from the 
5ebdd5
+# Folder Tree View (if specified). The default is YES.
5ebdd5
+
5ebdd5
+SHOW_FILES             = YES
5ebdd5
+
5ebdd5
+# Set the SHOW_NAMESPACES tag to NO to disable the generation of the 
5ebdd5
+# Namespaces page.  This will remove the Namespaces entry from the Quick Index
5ebdd5
+# and from the Folder Tree View (if specified). The default is YES.
5ebdd5
+
5ebdd5
+SHOW_NAMESPACES        = YES
5ebdd5
+
5ebdd5
+# The FILE_VERSION_FILTER tag can be used to specify a program or script that 
5ebdd5
+# doxygen should invoke to get the current version for each file (typically from 
5ebdd5
+# the version control system). Doxygen will invoke the program by executing (via 
5ebdd5
+# popen()) the command <command> <input-file>, where <command> is the value of 
5ebdd5
+# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file 
5ebdd5
+# provided by doxygen. Whatever the program writes to standard output 
5ebdd5
+# is used as the file version. See the manual for examples.
5ebdd5
+
5ebdd5
+FILE_VERSION_FILTER    = 
5ebdd5
+
5ebdd5
+# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed by 
5ebdd5
+# doxygen. The layout file controls the global structure of the generated output files 
5ebdd5
+# in an output format independent way. The create the layout file that represents 
5ebdd5
+# doxygen's defaults, run doxygen with the -l option. You can optionally specify a 
5ebdd5
+# file name after the option, if omitted DoxygenLayout.xml will be used as the name 
5ebdd5
+# of the layout file.
5ebdd5
+
5ebdd5
+LAYOUT_FILE            = 
5ebdd5
+
5ebdd5
+#---------------------------------------------------------------------------
5ebdd5
+# configuration options related to warning and progress messages
5ebdd5
+#---------------------------------------------------------------------------
5ebdd5
+
5ebdd5
+# The QUIET tag can be used to turn on/off the messages that are generated 
5ebdd5
+# by doxygen. Possible values are YES and NO. If left blank NO is used.
5ebdd5
+
5ebdd5
+QUIET                  = YES
5ebdd5
+
5ebdd5
+# The WARNINGS tag can be used to turn on/off the warning messages that are 
5ebdd5
+# generated by doxygen. Possible values are YES and NO. If left blank 
5ebdd5
+# NO is used.
5ebdd5
+
5ebdd5
+WARNINGS               = YES
5ebdd5
+
5ebdd5
+# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings 
5ebdd5
+# for undocumented members. If EXTRACT_ALL is set to YES then this flag will 
5ebdd5
+# automatically be disabled.
5ebdd5
+
5ebdd5
+WARN_IF_UNDOCUMENTED   = YES
5ebdd5
+
5ebdd5
+# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for 
5ebdd5
+# potential errors in the documentation, such as not documenting some 
5ebdd5
+# parameters in a documented function, or documenting parameters that 
5ebdd5
+# don't exist or using markup commands wrongly.
5ebdd5
+
5ebdd5
+WARN_IF_DOC_ERROR      = YES
5ebdd5
+
5ebdd5
+# This WARN_NO_PARAMDOC option can be abled to get warnings for 
5ebdd5
+# functions that are documented, but have no documentation for their parameters 
5ebdd5
+# or return value. If set to NO (the default) doxygen will only warn about 
5ebdd5
+# wrong or incomplete parameter documentation, but not about the absence of 
5ebdd5
+# documentation.
5ebdd5
+
5ebdd5
+WARN_NO_PARAMDOC       = NO
5ebdd5
+
5ebdd5
+# The WARN_FORMAT tag determines the format of the warning messages that 
5ebdd5
+# doxygen can produce. The string should contain the $file, $line, and $text 
5ebdd5
+# tags, which will be replaced by the file and line number from which the 
5ebdd5
+# warning originated and the warning text. Optionally the format may contain 
5ebdd5
+# $version, which will be replaced by the version of the file (if it could 
5ebdd5
+# be obtained via FILE_VERSION_FILTER)
5ebdd5
+
5ebdd5
+WARN_FORMAT            = "$file:$line: $text"
5ebdd5
+
5ebdd5
+# The WARN_LOGFILE tag can be used to specify a file to which warning 
5ebdd5
+# and error messages should be written. If left blank the output is written 
5ebdd5
+# to stderr.
5ebdd5
+
5ebdd5
+WARN_LOGFILE           = 
5ebdd5
+
5ebdd5
+#---------------------------------------------------------------------------
5ebdd5
+# configuration options related to the input files
5ebdd5
+#---------------------------------------------------------------------------
5ebdd5
+
5ebdd5
+# The INPUT tag can be used to specify the files and/or directories that contain 
5ebdd5
+# documented source files. You may enter file names like "myfile.cpp" or 
5ebdd5
+# directories like "/usr/src/myproject". Separate the files or directories 
5ebdd5
+# with spaces.
5ebdd5
+
5ebdd5
+INPUT                  = 
5ebdd5
+
5ebdd5
+# This tag can be used to specify the character encoding of the source files 
5ebdd5
+# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is 
5ebdd5
+# also the default input encoding. Doxygen uses libiconv (or the iconv built 
5ebdd5
+# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for 
5ebdd5
+# the list of possible encodings.
5ebdd5
+
5ebdd5
+INPUT_ENCODING         = UTF-8
5ebdd5
+
5ebdd5
+# If the value of the INPUT tag contains directories, you can use the 
5ebdd5
+# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 
5ebdd5
+# and *.h) to filter out the source-files in the directories. If left 
5ebdd5
+# blank the following patterns are tested: 
5ebdd5
+# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx 
5ebdd5
+# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
5ebdd5
+
5ebdd5
+FILE_PATTERNS          = 
5ebdd5
+
5ebdd5
+# The RECURSIVE tag can be used to turn specify whether or not subdirectories 
5ebdd5
+# should be searched for input files as well. Possible values are YES and NO. 
5ebdd5
+# If left blank NO is used.
5ebdd5
+
5ebdd5
+RECURSIVE              = NO
5ebdd5
+
5ebdd5
+# The EXCLUDE tag can be used to specify files and/or directories that should 
5ebdd5
+# excluded from the INPUT source files. This way you can easily exclude a 
5ebdd5
+# subdirectory from a directory tree whose root is specified with the INPUT tag.
5ebdd5
+
5ebdd5
+EXCLUDE                = 
5ebdd5
+
5ebdd5
+# The EXCLUDE_SYMLINKS tag can be used select whether or not files or 
5ebdd5
+# directories that are symbolic links (a Unix filesystem feature) are excluded 
5ebdd5
+# from the input.
5ebdd5
+
5ebdd5
+EXCLUDE_SYMLINKS       = NO
5ebdd5
+
5ebdd5
+# If the value of the INPUT tag contains directories, you can use the 
5ebdd5
+# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 
5ebdd5
+# certain files from those directories. Note that the wildcards are matched 
5ebdd5
+# against the file with absolute path, so to exclude all test directories 
5ebdd5
+# for example use the pattern */test/*
5ebdd5
+
5ebdd5
+EXCLUDE_PATTERNS       = 
5ebdd5
+
5ebdd5
+# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names 
5ebdd5
+# (namespaces, classes, functions, etc.) that should be excluded from the 
5ebdd5
+# output. The symbol name can be a fully qualified name, a word, or if the 
5ebdd5
+# wildcard * is used, a substring. Examples: ANamespace, AClass, 
5ebdd5
+# AClass::ANamespace, ANamespace::*Test
5ebdd5
+
5ebdd5
+EXCLUDE_SYMBOLS        = 
5ebdd5
+
5ebdd5
+# The EXAMPLE_PATH tag can be used to specify one or more files or 
5ebdd5
+# directories that contain example code fragments that are included (see 
5ebdd5
+# the \include command).
5ebdd5
+
5ebdd5
+EXAMPLE_PATH           = 
5ebdd5
+
5ebdd5
+# If the value of the EXAMPLE_PATH tag contains directories, you can use the 
5ebdd5
+# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 
5ebdd5
+# and *.h) to filter out the source-files in the directories. If left 
5ebdd5
+# blank all files are included.
5ebdd5
+
5ebdd5
+EXAMPLE_PATTERNS       = 
5ebdd5
+
5ebdd5
+# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 
5ebdd5
+# searched for input files to be used with the \include or \dontinclude 
5ebdd5
+# commands irrespective of the value of the RECURSIVE tag. 
5ebdd5
+# Possible values are YES and NO. If left blank NO is used.
5ebdd5
+
5ebdd5
+EXAMPLE_RECURSIVE      = NO
5ebdd5
+
5ebdd5
+# The IMAGE_PATH tag can be used to specify one or more files or 
5ebdd5
+# directories that contain image that are included in the documentation (see 
5ebdd5
+# the \image command).
5ebdd5
+
5ebdd5
+IMAGE_PATH             = 
5ebdd5
+
5ebdd5
+# The INPUT_FILTER tag can be used to specify a program that doxygen should 
5ebdd5
+# invoke to filter for each input file. Doxygen will invoke the filter program 
5ebdd5
+# by executing (via popen()) the command <filter> <input-file>, where <filter> 
5ebdd5
+# is the value of the INPUT_FILTER tag, and <input-file> is the name of an 
5ebdd5
+# input file. Doxygen will then use the output that the filter program writes 
5ebdd5
+# to standard output.  If FILTER_PATTERNS is specified, this tag will be 
5ebdd5
+# ignored.
5ebdd5
+
5ebdd5
+INPUT_FILTER           = 
5ebdd5
+
5ebdd5
+# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 
5ebdd5
+# basis.  Doxygen will compare the file name with each pattern and apply the 
5ebdd5
+# filter if there is a match.  The filters are a list of the form: 
5ebdd5
+# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further 
5ebdd5
+# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER 
5ebdd5
+# is applied to all files.
5ebdd5
+
5ebdd5
+FILTER_PATTERNS        = 
5ebdd5
+
5ebdd5
+# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 
5ebdd5
+# INPUT_FILTER) will be used to filter the input files when producing source 
5ebdd5
+# files to browse (i.e. when SOURCE_BROWSER is set to YES).
5ebdd5
+
5ebdd5
+FILTER_SOURCE_FILES    = NO
5ebdd5
+
5ebdd5
+#---------------------------------------------------------------------------
5ebdd5
+# configuration options related to source browsing
5ebdd5
+#---------------------------------------------------------------------------
5ebdd5
+
5ebdd5
+# If the SOURCE_BROWSER tag is set to YES then a list of source files will 
5ebdd5
+# be generated. Documented entities will be cross-referenced with these sources. 
5ebdd5
+# Note: To get rid of all source code in the generated output, make sure also 
5ebdd5
+# VERBATIM_HEADERS is set to NO.
5ebdd5
+
5ebdd5
+SOURCE_BROWSER         = NO
5ebdd5
+
5ebdd5
+# Setting the INLINE_SOURCES tag to YES will include the body 
5ebdd5
+# of functions and classes directly in the documentation.
5ebdd5
+
5ebdd5
+INLINE_SOURCES         = NO
5ebdd5
+
5ebdd5
+# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct 
5ebdd5
+# doxygen to hide any special comment blocks from generated source code 
5ebdd5
+# fragments. Normal C and C++ comments will always remain visible.
5ebdd5
+
5ebdd5
+STRIP_CODE_COMMENTS    = YES
5ebdd5
+
5ebdd5
+# If the REFERENCED_BY_RELATION tag is set to YES 
5ebdd5
+# then for each documented function all documented 
5ebdd5
+# functions referencing it will be listed.
5ebdd5
+
5ebdd5
+REFERENCED_BY_RELATION = NO
5ebdd5
+
5ebdd5
+# If the REFERENCES_RELATION tag is set to YES 
5ebdd5
+# then for each documented function all documented entities 
5ebdd5
+# called/used by that function will be listed.
5ebdd5
+
5ebdd5
+REFERENCES_RELATION    = NO
5ebdd5
+
5ebdd5
+# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
5ebdd5
+# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
5ebdd5
+# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
5ebdd5
+# link to the source code.  Otherwise they will link to the documentstion.
5ebdd5
+
5ebdd5
+REFERENCES_LINK_SOURCE = YES
5ebdd5
+
5ebdd5
+# If the USE_HTAGS tag is set to YES then the references to source code 
5ebdd5
+# will point to the HTML generated by the htags(1) tool instead of doxygen 
5ebdd5
+# built-in source browser. The htags tool is part of GNU's global source 
5ebdd5
+# tagging system (see http://www.gnu.org/software/global/global.html). You 
5ebdd5
+# will need version 4.8.6 or higher.
5ebdd5
+
5ebdd5
+USE_HTAGS              = NO
5ebdd5
+
5ebdd5
+# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen 
5ebdd5
+# will generate a verbatim copy of the header file for each class for 
5ebdd5
+# which an include is specified. Set to NO to disable this.
5ebdd5
+
5ebdd5
+VERBATIM_HEADERS       = YES
5ebdd5
+
5ebdd5
+#---------------------------------------------------------------------------
5ebdd5
+# configuration options related to the alphabetical class index
5ebdd5
+#---------------------------------------------------------------------------
5ebdd5
+
5ebdd5
+# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index 
5ebdd5
+# of all compounds will be generated. Enable this if the project 
5ebdd5
+# contains a lot of classes, structs, unions or interfaces.
5ebdd5
+
5ebdd5
+ALPHABETICAL_INDEX     = NO
5ebdd5
+
5ebdd5
+# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then 
5ebdd5
+# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns 
5ebdd5
+# in which this list will be split (can be a number in the range [1..20])
5ebdd5
+
5ebdd5
+COLS_IN_ALPHA_INDEX    = 5
5ebdd5
+
5ebdd5
+# In case all classes in a project start with a common prefix, all 
5ebdd5
+# classes will be put under the same header in the alphabetical index. 
5ebdd5
+# The IGNORE_PREFIX tag can be used to specify one or more prefixes that 
5ebdd5
+# should be ignored while generating the index headers.
5ebdd5
+
5ebdd5
+IGNORE_PREFIX          = 
5ebdd5
+
5ebdd5
+#---------------------------------------------------------------------------
5ebdd5
+# configuration options related to the HTML output
5ebdd5
+#---------------------------------------------------------------------------
5ebdd5
+
5ebdd5
+# If the GENERATE_HTML tag is set to YES (the default) Doxygen will 
5ebdd5
+# generate HTML output.
5ebdd5
+
5ebdd5
+GENERATE_HTML          = YES
5ebdd5
+
5ebdd5
+# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. 
5ebdd5
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be 
5ebdd5
+# put in front of it. If left blank `html' will be used as the default path.
5ebdd5
+
5ebdd5
+HTML_OUTPUT            = html
5ebdd5
+
5ebdd5
+# The HTML_FILE_EXTENSION tag can be used to specify the file extension for 
5ebdd5
+# each generated HTML page (for example: .htm,.php,.asp). If it is left blank 
5ebdd5
+# doxygen will generate files with .html extension.
5ebdd5
+
5ebdd5
+HTML_FILE_EXTENSION    = .html
5ebdd5
+
5ebdd5
+# The HTML_HEADER tag can be used to specify a personal HTML header for 
5ebdd5
+# each generated HTML page. If it is left blank doxygen will generate a 
5ebdd5
+# standard header.
5ebdd5
+
5ebdd5
+HTML_HEADER            = 
5ebdd5
+
5ebdd5
+# The HTML_FOOTER tag can be used to specify a personal HTML footer for 
5ebdd5
+# each generated HTML page. If it is left blank doxygen will generate a 
5ebdd5
+# standard footer.
5ebdd5
+
278948
+HTML_FOOTER            = no_date_footer.html
5ebdd5
+
5ebdd5
+# The HTML_STYLESHEET tag can be used to specify a user-defined cascading 
5ebdd5
+# style sheet that is used by each HTML page. It can be used to 
5ebdd5
+# fine-tune the look of the HTML output. If the tag is left blank doxygen 
5ebdd5
+# will generate a default style sheet. Note that doxygen will try to copy 
5ebdd5
+# the style sheet file to the HTML output directory, so don't put your own 
5ebdd5
+# stylesheet in the HTML output directory as well, or it will be erased!
5ebdd5
+
5ebdd5
+HTML_STYLESHEET        = 
5ebdd5
+
5ebdd5
+# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, 
5ebdd5
+# files or namespaces will be aligned in HTML using tables. If set to 
5ebdd5
+# NO a bullet list will be used.
5ebdd5
+
5ebdd5
+HTML_ALIGN_MEMBERS     = YES
5ebdd5
+
5ebdd5
+# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML 
5ebdd5
+# documentation will contain sections that can be hidden and shown after the 
5ebdd5
+# page has loaded. For this to work a browser that supports 
5ebdd5
+# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox 
5ebdd5
+# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
5ebdd5
+
5ebdd5
+HTML_DYNAMIC_SECTIONS  = NO
5ebdd5
+
5ebdd5
+# If the GENERATE_DOCSET tag is set to YES, additional index files 
5ebdd5
+# will be generated that can be used as input for Apple's Xcode 3 
5ebdd5
+# integrated development environment, introduced with OSX 10.5 (Leopard). 
5ebdd5
+# To create a documentation set, doxygen will generate a Makefile in the 
5ebdd5
+# HTML output directory. Running make will produce the docset in that 
5ebdd5
+# directory and running "make install" will install the docset in 
5ebdd5
+# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find 
5ebdd5
+# it at startup. 
5ebdd5
+# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for more information.
5ebdd5
+
5ebdd5
+GENERATE_DOCSET        = NO
5ebdd5
+
5ebdd5
+# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the 
5ebdd5
+# feed. A documentation feed provides an umbrella under which multiple 
5ebdd5
+# documentation sets from a single provider (such as a company or product suite) 
5ebdd5
+# can be grouped.
5ebdd5
+
5ebdd5
+DOCSET_FEEDNAME        = "Doxygen generated docs"
5ebdd5
+
5ebdd5
+# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that 
5ebdd5
+# should uniquely identify the documentation set bundle. This should be a 
5ebdd5
+# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen 
5ebdd5
+# will append .docset to the name.
5ebdd5
+
5ebdd5
+DOCSET_BUNDLE_ID       = org.doxygen.Project
5ebdd5
+
5ebdd5
+# If the GENERATE_HTMLHELP tag is set to YES, additional index files 
5ebdd5
+# will be generated that can be used as input for tools like the 
5ebdd5
+# Microsoft HTML help workshop to generate a compiled HTML help file (.chm) 
5ebdd5
+# of the generated HTML documentation.
5ebdd5
+
5ebdd5
+GENERATE_HTMLHELP      = NO
5ebdd5
+
5ebdd5
+# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can 
5ebdd5
+# be used to specify the file name of the resulting .chm file. You 
5ebdd5
+# can add a path in front of the file if the result should not be 
5ebdd5
+# written to the html output directory.
5ebdd5
+
5ebdd5
+CHM_FILE               = 
5ebdd5
+
5ebdd5
+# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can 
5ebdd5
+# be used to specify the location (absolute path including file name) of 
5ebdd5
+# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run 
5ebdd5
+# the HTML help compiler on the generated index.hhp.
5ebdd5
+
5ebdd5
+HHC_LOCATION           = 
5ebdd5
+
5ebdd5
+# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag 
5ebdd5
+# controls if a separate .chi index file is generated (YES) or that 
5ebdd5
+# it should be included in the master .chm file (NO).
5ebdd5
+
5ebdd5
+GENERATE_CHI           = NO
5ebdd5
+
5ebdd5
+# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
5ebdd5
+# is used to encode HtmlHelp index (hhk), content (hhc) and project file
5ebdd5
+# content.
5ebdd5
+
5ebdd5
+CHM_INDEX_ENCODING     = 
5ebdd5
+
5ebdd5
+# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag 
5ebdd5
+# controls whether a binary table of contents is generated (YES) or a 
5ebdd5
+# normal table of contents (NO) in the .chm file.
5ebdd5
+
5ebdd5
+BINARY_TOC             = NO
5ebdd5
+
5ebdd5
+# The TOC_EXPAND flag can be set to YES to add extra items for group members 
5ebdd5
+# to the contents of the HTML help documentation and to the tree view.
5ebdd5
+
5ebdd5
+TOC_EXPAND             = NO
5ebdd5
+
5ebdd5
+# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER 
5ebdd5
+# are set, an additional index file will be generated that can be used as input for 
5ebdd5
+# Qt's qhelpgenerator to generate a Qt Compressed Help (.qch) of the generated 
5ebdd5
+# HTML documentation.
5ebdd5
+
5ebdd5
+GENERATE_QHP           = NO
5ebdd5
+
5ebdd5
+# If the QHG_LOCATION tag is specified, the QCH_FILE tag can 
5ebdd5
+# be used to specify the file name of the resulting .qch file. 
5ebdd5
+# The path specified is relative to the HTML output folder.
5ebdd5
+
5ebdd5
+QCH_FILE               = 
5ebdd5
+
5ebdd5
+# The QHP_NAMESPACE tag specifies the namespace to use when generating 
5ebdd5
+# Qt Help Project output. For more information please see 
5ebdd5
+# Qt Help Project / Namespace.
5ebdd5
+
5ebdd5
+QHP_NAMESPACE          = org.doxygen.Project
5ebdd5
+
5ebdd5
+# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating 
5ebdd5
+# Qt Help Project output. For more information please see 
5ebdd5
+# Qt Help Project / Virtual Folders.
5ebdd5
+
5ebdd5
+QHP_VIRTUAL_FOLDER     = doc
5ebdd5
+
5ebdd5
+# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can 
5ebdd5
+# be used to specify the location of Qt's qhelpgenerator. 
5ebdd5
+# If non-empty doxygen will try to run qhelpgenerator on the generated 
5ebdd5
+# .qhp file .
5ebdd5
+
5ebdd5
+QHG_LOCATION           = 
5ebdd5
+
5ebdd5
+# The DISABLE_INDEX tag can be used to turn on/off the condensed index at 
5ebdd5
+# top of each HTML page. The value NO (the default) enables the index and 
5ebdd5
+# the value YES disables it.
5ebdd5
+
5ebdd5
+DISABLE_INDEX          = NO
5ebdd5
+
5ebdd5
+# This tag can be used to set the number of enum values (range [1..20]) 
5ebdd5
+# that doxygen will group on one line in the generated HTML documentation.
5ebdd5
+
5ebdd5
+ENUM_VALUES_PER_LINE   = 4
5ebdd5
+
5ebdd5
+# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
5ebdd5
+# structure should be generated to display hierarchical information.
5ebdd5
+# If the tag value is set to FRAME, a side panel will be generated
5ebdd5
+# containing a tree-like index structure (just like the one that 
5ebdd5
+# is generated for HTML Help). For this to work a browser that supports 
5ebdd5
+# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, 
5ebdd5
+# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are 
5ebdd5
+# probably better off using the HTML help feature. Other possible values 
5ebdd5
+# for this tag are: HIERARCHIES, which will generate the Groups, Directories,
5ebdd5
+# and Class Hierarchy pages using a tree view instead of an ordered list;
5ebdd5
+# ALL, which combines the behavior of FRAME and HIERARCHIES; and NONE, which
5ebdd5
+# disables this behavior completely. For backwards compatibility with previous
5ebdd5
+# releases of Doxygen, the values YES and NO are equivalent to FRAME and NONE
5ebdd5
+# respectively.
5ebdd5
+
5ebdd5
+GENERATE_TREEVIEW      = NONE
5ebdd5
+
5ebdd5
+# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be 
5ebdd5
+# used to set the initial width (in pixels) of the frame in which the tree 
5ebdd5
+# is shown.
5ebdd5
+
5ebdd5
+TREEVIEW_WIDTH         = 250
5ebdd5
+
5ebdd5
+# Use this tag to change the font size of Latex formulas included 
5ebdd5
+# as images in the HTML documentation. The default is 10. Note that 
5ebdd5
+# when you change the font size after a successful doxygen run you need 
5ebdd5
+# to manually remove any form_*.png images from the HTML output directory 
5ebdd5
+# to force them to be regenerated.
5ebdd5
+
5ebdd5
+FORMULA_FONTSIZE       = 10
5ebdd5
+
5ebdd5
+#---------------------------------------------------------------------------
5ebdd5
+# configuration options related to the LaTeX output
5ebdd5
+#---------------------------------------------------------------------------
5ebdd5
+
5ebdd5
+# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will 
5ebdd5
+# generate Latex output.
5ebdd5
+
5ebdd5
+GENERATE_LATEX         = NO
5ebdd5
+
5ebdd5
+# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. 
5ebdd5
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be 
5ebdd5
+# put in front of it. If left blank `latex' will be used as the default path.
5ebdd5
+
5ebdd5
+LATEX_OUTPUT           = latex
5ebdd5
+
5ebdd5
+# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be 
5ebdd5
+# invoked. If left blank `latex' will be used as the default command name.
5ebdd5
+
5ebdd5
+LATEX_CMD_NAME         = latex
5ebdd5
+
5ebdd5
+# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to 
5ebdd5
+# generate index for LaTeX. If left blank `makeindex' will be used as the 
5ebdd5
+# default command name.
5ebdd5
+
5ebdd5
+MAKEINDEX_CMD_NAME     = makeindex
5ebdd5
+
5ebdd5
+# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact 
5ebdd5
+# LaTeX documents. This may be useful for small projects and may help to 
5ebdd5
+# save some trees in general.
5ebdd5
+
5ebdd5
+COMPACT_LATEX          = NO
5ebdd5
+
5ebdd5
+# The PAPER_TYPE tag can be used to set the paper type that is used 
5ebdd5
+# by the printer. Possible values are: a4, a4wide, letter, legal and 
5ebdd5
+# executive. If left blank a4wide will be used.
5ebdd5
+
5ebdd5
+PAPER_TYPE             = a4wide
5ebdd5
+
5ebdd5
+# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX 
5ebdd5
+# packages that should be included in the LaTeX output.
5ebdd5
+
5ebdd5
+EXTRA_PACKAGES         = 
5ebdd5
+
5ebdd5
+# The LATEX_HEADER tag can be used to specify a personal LaTeX header for 
5ebdd5
+# the generated latex document. The header should contain everything until 
5ebdd5
+# the first chapter. If it is left blank doxygen will generate a 
5ebdd5
+# standard header. Notice: only use this tag if you know what you are doing!
5ebdd5
+
5ebdd5
+LATEX_HEADER           = 
5ebdd5
+
5ebdd5
+# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated 
5ebdd5
+# is prepared for conversion to pdf (using ps2pdf). The pdf file will 
5ebdd5
+# contain links (just like the HTML output) instead of page references 
5ebdd5
+# This makes the output suitable for online browsing using a pdf viewer.
5ebdd5
+
5ebdd5
+PDF_HYPERLINKS         = YES
5ebdd5
+
5ebdd5
+# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of 
5ebdd5
+# plain latex in the generated Makefile. Set this option to YES to get a 
5ebdd5
+# higher quality PDF documentation.
5ebdd5
+
5ebdd5
+USE_PDFLATEX           = YES
5ebdd5
+
5ebdd5
+# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. 
5ebdd5
+# command to the generated LaTeX files. This will instruct LaTeX to keep 
5ebdd5
+# running if errors occur, instead of asking the user for help. 
5ebdd5
+# This option is also used when generating formulas in HTML.
5ebdd5
+
5ebdd5
+LATEX_BATCHMODE        = NO
5ebdd5
+
5ebdd5
+# If LATEX_HIDE_INDICES is set to YES then doxygen will not 
5ebdd5
+# include the index chapters (such as File Index, Compound Index, etc.) 
5ebdd5
+# in the output.
5ebdd5
+
5ebdd5
+LATEX_HIDE_INDICES     = NO
5ebdd5
+
5ebdd5
+#---------------------------------------------------------------------------
5ebdd5
+# configuration options related to the RTF output
5ebdd5
+#---------------------------------------------------------------------------
5ebdd5
+
5ebdd5
+# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output 
5ebdd5
+# The RTF output is optimized for Word 97 and may not look very pretty with 
5ebdd5
+# other RTF readers or editors.
5ebdd5
+
5ebdd5
+GENERATE_RTF           = NO
5ebdd5
+
5ebdd5
+# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. 
5ebdd5
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be 
5ebdd5
+# put in front of it. If left blank `rtf' will be used as the default path.
5ebdd5
+
5ebdd5
+RTF_OUTPUT             = rtf
5ebdd5
+
5ebdd5
+# If the COMPACT_RTF tag is set to YES Doxygen generates more compact 
5ebdd5
+# RTF documents. This may be useful for small projects and may help to 
5ebdd5
+# save some trees in general.
5ebdd5
+
5ebdd5
+COMPACT_RTF            = NO
5ebdd5
+
5ebdd5
+# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated 
5ebdd5
+# will contain hyperlink fields. The RTF file will 
5ebdd5
+# contain links (just like the HTML output) instead of page references. 
5ebdd5
+# This makes the output suitable for online browsing using WORD or other 
5ebdd5
+# programs which support those fields. 
5ebdd5
+# Note: wordpad (write) and others do not support links.
5ebdd5
+
5ebdd5
+RTF_HYPERLINKS         = NO
5ebdd5
+
5ebdd5
+# Load stylesheet definitions from file. Syntax is similar to doxygen's 
5ebdd5
+# config file, i.e. a series of assignments. You only have to provide 
5ebdd5
+# replacements, missing definitions are set to their default value.
5ebdd5
+
5ebdd5
+RTF_STYLESHEET_FILE    = 
5ebdd5
+
5ebdd5
+# Set optional variables used in the generation of an rtf document. 
5ebdd5
+# Syntax is similar to doxygen's config file.
5ebdd5
+
5ebdd5
+RTF_EXTENSIONS_FILE    = 
5ebdd5
+
5ebdd5
+#---------------------------------------------------------------------------
5ebdd5
+# configuration options related to the man page output
5ebdd5
+#---------------------------------------------------------------------------
5ebdd5
+
5ebdd5
+# If the GENERATE_MAN tag is set to YES (the default) Doxygen will 
5ebdd5
+# generate man pages
5ebdd5
+
5ebdd5
+GENERATE_MAN           = NO
5ebdd5
+
5ebdd5
+# The MAN_OUTPUT tag is used to specify where the man pages will be put. 
5ebdd5
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be 
5ebdd5
+# put in front of it. If left blank `man' will be used as the default path.
5ebdd5
+
5ebdd5
+MAN_OUTPUT             = man
5ebdd5
+
5ebdd5
+# The MAN_EXTENSION tag determines the extension that is added to 
5ebdd5
+# the generated man pages (default is the subroutine's section .3)
5ebdd5
+
5ebdd5
+MAN_EXTENSION          = .3
5ebdd5
+
5ebdd5
+# If the MAN_LINKS tag is set to YES and Doxygen generates man output, 
5ebdd5
+# then it will generate one additional man file for each entity 
5ebdd5
+# documented in the real man page(s). These additional files 
5ebdd5
+# only source the real man page, but without them the man command 
5ebdd5
+# would be unable to find the correct page. The default is NO.
5ebdd5
+
5ebdd5
+MAN_LINKS              = NO
5ebdd5
+
5ebdd5
+#---------------------------------------------------------------------------
5ebdd5
+# configuration options related to the XML output
5ebdd5
+#---------------------------------------------------------------------------
5ebdd5
+
5ebdd5
+# If the GENERATE_XML tag is set to YES Doxygen will 
5ebdd5
+# generate an XML file that captures the structure of 
5ebdd5
+# the code including all documentation.
5ebdd5
+
5ebdd5
+GENERATE_XML           = NO
5ebdd5
+
5ebdd5
+# The XML_OUTPUT tag is used to specify where the XML pages will be put. 
5ebdd5
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be 
5ebdd5
+# put in front of it. If left blank `xml' will be used as the default path.
5ebdd5
+
5ebdd5
+XML_OUTPUT             = xml
5ebdd5
+
5ebdd5
+# The XML_SCHEMA tag can be used to specify an XML schema, 
5ebdd5
+# which can be used by a validating XML parser to check the 
5ebdd5
+# syntax of the XML files.
5ebdd5
+
5ebdd5
+XML_SCHEMA             = 
5ebdd5
+
5ebdd5
+# The XML_DTD tag can be used to specify an XML DTD, 
5ebdd5
+# which can be used by a validating XML parser to check the 
5ebdd5
+# syntax of the XML files.
5ebdd5
+
5ebdd5
+XML_DTD                = 
5ebdd5
+
5ebdd5
+# If the XML_PROGRAMLISTING tag is set to YES Doxygen will 
5ebdd5
+# dump the program listings (including syntax highlighting 
5ebdd5
+# and cross-referencing information) to the XML output. Note that 
5ebdd5
+# enabling this will significantly increase the size of the XML output.
5ebdd5
+
5ebdd5
+XML_PROGRAMLISTING     = YES
5ebdd5
+
5ebdd5
+#---------------------------------------------------------------------------
5ebdd5
+# configuration options for the AutoGen Definitions output
5ebdd5
+#---------------------------------------------------------------------------
5ebdd5
+
5ebdd5
+# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will 
5ebdd5
+# generate an AutoGen Definitions (see autogen.sf.net) file 
5ebdd5
+# that captures the structure of the code including all 
5ebdd5
+# documentation. Note that this feature is still experimental 
5ebdd5
+# and incomplete at the moment.
5ebdd5
+
5ebdd5
+GENERATE_AUTOGEN_DEF   = NO
5ebdd5
+
5ebdd5
+#---------------------------------------------------------------------------
5ebdd5
+# configuration options related to the Perl module output
5ebdd5
+#---------------------------------------------------------------------------
5ebdd5
+
5ebdd5
+# If the GENERATE_PERLMOD tag is set to YES Doxygen will 
5ebdd5
+# generate a Perl module file that captures the structure of 
5ebdd5
+# the code including all documentation. Note that this 
5ebdd5
+# feature is still experimental and incomplete at the 
5ebdd5
+# moment.
5ebdd5
+
5ebdd5
+GENERATE_PERLMOD       = NO
5ebdd5
+
5ebdd5
+# If the PERLMOD_LATEX tag is set to YES Doxygen will generate 
5ebdd5
+# the necessary Makefile rules, Perl scripts and LaTeX code to be able 
5ebdd5
+# to generate PDF and DVI output from the Perl module output.
5ebdd5
+
5ebdd5
+PERLMOD_LATEX          = NO
5ebdd5
+
5ebdd5
+# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be 
5ebdd5
+# nicely formatted so it can be parsed by a human reader.  This is useful 
5ebdd5
+# if you want to understand what is going on.  On the other hand, if this 
5ebdd5
+# tag is set to NO the size of the Perl module output will be much smaller 
5ebdd5
+# and Perl will parse it just the same.
5ebdd5
+
5ebdd5
+PERLMOD_PRETTY         = YES
5ebdd5
+
5ebdd5
+# The names of the make variables in the generated doxyrules.make file 
5ebdd5
+# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. 
5ebdd5
+# This is useful so different doxyrules.make files included by the same 
5ebdd5
+# Makefile don't overwrite each other's variables.
5ebdd5
+
5ebdd5
+PERLMOD_MAKEVAR_PREFIX = 
5ebdd5
+
5ebdd5
+#---------------------------------------------------------------------------
5ebdd5
+# Configuration options related to the preprocessor   
5ebdd5
+#---------------------------------------------------------------------------
5ebdd5
+
5ebdd5
+# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will 
5ebdd5
+# evaluate all C-preprocessor directives found in the sources and include 
5ebdd5
+# files.
5ebdd5
+
5ebdd5
+ENABLE_PREPROCESSING   = YES
5ebdd5
+
5ebdd5
+# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro 
5ebdd5
+# names in the source code. If set to NO (the default) only conditional 
5ebdd5
+# compilation will be performed. Macro expansion can be done in a controlled 
5ebdd5
+# way by setting EXPAND_ONLY_PREDEF to YES.
5ebdd5
+
5ebdd5
+MACRO_EXPANSION        = NO
5ebdd5
+
5ebdd5
+# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES 
5ebdd5
+# then the macro expansion is limited to the macros specified with the 
5ebdd5
+# PREDEFINED and EXPAND_AS_DEFINED tags.
5ebdd5
+
5ebdd5
+EXPAND_ONLY_PREDEF     = NO
5ebdd5
+
5ebdd5
+# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files 
5ebdd5
+# in the INCLUDE_PATH (see below) will be search if a #include is found.
5ebdd5
+
5ebdd5
+SEARCH_INCLUDES        = YES
5ebdd5
+
5ebdd5
+# The INCLUDE_PATH tag can be used to specify one or more directories that 
5ebdd5
+# contain include files that are not input files but should be processed by 
5ebdd5
+# the preprocessor.
5ebdd5
+
5ebdd5
+INCLUDE_PATH           = 
5ebdd5
+
5ebdd5
+# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard 
5ebdd5
+# patterns (like *.h and *.hpp) to filter out the header-files in the 
5ebdd5
+# directories. If left blank, the patterns specified with FILE_PATTERNS will 
5ebdd5
+# be used.
5ebdd5
+
5ebdd5
+INCLUDE_FILE_PATTERNS  = 
5ebdd5
+
5ebdd5
+# The PREDEFINED tag can be used to specify one or more macro names that 
5ebdd5
+# are defined before the preprocessor is started (similar to the -D option of 
5ebdd5
+# gcc). The argument of the tag is a list of macros of the form: name 
5ebdd5
+# or name=definition (no spaces). If the definition and the = are 
5ebdd5
+# omitted =1 is assumed. To prevent a macro definition from being 
5ebdd5
+# undefined via #undef or recursively expanded use the := operator 
5ebdd5
+# instead of the = operator.
5ebdd5
+
5ebdd5
+PREDEFINED             = 
5ebdd5
+
5ebdd5
+# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then 
5ebdd5
+# this tag can be used to specify a list of macro names that should be expanded. 
5ebdd5
+# The macro definition that is found in the sources will be used. 
5ebdd5
+# Use the PREDEFINED tag if you want to use a different macro definition.
5ebdd5
+
5ebdd5
+EXPAND_AS_DEFINED      = 
5ebdd5
+
5ebdd5
+# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then 
5ebdd5
+# doxygen's preprocessor will remove all function-like macros that are alone 
5ebdd5
+# on a line, have an all uppercase name, and do not end with a semicolon. Such 
5ebdd5
+# function macros are typically used for boiler-plate code, and will confuse 
5ebdd5
+# the parser if not removed.
5ebdd5
+
5ebdd5
+SKIP_FUNCTION_MACROS   = YES
5ebdd5
+
5ebdd5
+#---------------------------------------------------------------------------
5ebdd5
+# Configuration::additions related to external references   
5ebdd5
+#---------------------------------------------------------------------------
5ebdd5
+
5ebdd5
+# The TAGFILES option can be used to specify one or more tagfiles. 
5ebdd5
+# Optionally an initial location of the external documentation 
5ebdd5
+# can be added for each tagfile. The format of a tag file without 
5ebdd5
+# this location is as follows: 
5ebdd5
+#   TAGFILES = file1 file2 ... 
5ebdd5
+# Adding location for the tag files is done as follows: 
5ebdd5
+#   TAGFILES = file1=loc1 "file2 = loc2" ... 
5ebdd5
+# where "loc1" and "loc2" can be relative or absolute paths or 
5ebdd5
+# URLs. If a location is present for each tag, the installdox tool 
5ebdd5
+# does not have to be run to correct the links.
5ebdd5
+# Note that each tag file must have a unique name
5ebdd5
+# (where the name does NOT include the path)
5ebdd5
+# If a tag file is not located in the directory in which doxygen 
5ebdd5
+# is run, you must also specify the path to the tagfile here.
5ebdd5
+
5ebdd5
+TAGFILES               = 
5ebdd5
+
5ebdd5
+# When a file name is specified after GENERATE_TAGFILE, doxygen will create 
5ebdd5
+# a tag file that is based on the input files it reads.
5ebdd5
+
5ebdd5
+GENERATE_TAGFILE       = 
5ebdd5
+
5ebdd5
+# If the ALLEXTERNALS tag is set to YES all external classes will be listed 
5ebdd5
+# in the class index. If set to NO only the inherited external classes 
5ebdd5
+# will be listed.
5ebdd5
+
5ebdd5
+ALLEXTERNALS           = NO
5ebdd5
+
5ebdd5
+# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed 
5ebdd5
+# in the modules index. If set to NO, only the current project's groups will 
5ebdd5
+# be listed.
5ebdd5
+
5ebdd5
+EXTERNAL_GROUPS        = YES