added dynamic interface manipulation for guests
[strongswan.git] / src / dumm / dumm.h
index f18817a..fd2ba46 100644 (file)
@@ -1,3 +1,18 @@
+/*
+ * Copyright (C) 2007 Martin Willi
+ * Hochschule fuer Technik Rapperswil
+ *
+ * This program is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License as published by the
+ * Free Software Foundation; either version 2 of the License, or (at your
+ * option) any later version.  See <http://www.fsf.org/copyleft/gpl.txt>.
+ *
+ * This program is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
+ * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+ * for more details.
+ */
+
 #ifndef DUMM_H
 #define DUMM_H
 
@@ -45,6 +60,14 @@ struct dumm_t {
        void (*destroy) (dumm_t *this);
 };
 
+/**
+ * @brief Create a new group of UML hosts and networks.
+ *
+ * Dumm uses its working dir to create folders and files it works with.
+ *
+ * @return                             created UML group, or NULL if failed.
+ */
 dumm_t *dumm_create();
 
 #endif /* DUMM_H */
+