X-Git-Url: https://git.verplant.org/?a=blobdiff_plain;f=src%2Fpyconfig.c;h=bac39ae90b7d1eccb537e5765d5b41648ffad9ff;hb=3bd6fcdfd20002eee1f1803460728449c0c98f86;hp=a6b4469fa308dd7f62716dffac0e38e5f7ba6600;hpb=045cf31cc5f85b703083da7383410bed4a667817;p=collectd.git

diff --git a/src/pyconfig.c b/src/pyconfig.c
index a6b4469f..bac39ae9 100644
--- a/src/pyconfig.c
+++ b/src/pyconfig.c
@@ -1,3 +1,29 @@
+/**
+ * collectd - src/pyconfig.c
+ * Copyright (C) 2009  Sven Trenkel
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a
+ * copy of this software and associated documentation files (the "Software"),
+ * to deal in the Software without restriction, including without limitation
+ * the rights to use, copy, modify, merge, publish, distribute, sublicense,
+ * and/or sell copies of the Software, and to permit persons to whom the
+ * Software is furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+ * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+ * DEALINGS IN THE SOFTWARE.
+ *
+ * Authors:
+ *   Sven Trenkel <collectd at semidefinite.de>  
+ **/
+
 #include <Python.h>
 #include <structmember.h>
 
@@ -6,6 +32,29 @@
 
 #include "cpython.h"
 
+static char config_doc[] = "This represents a piece of collectd's config file.\n"
+		"It is passed to scripts with config callbacks (see \"register_config\")\n"
+		"and is of little use if created somewhere else.\n"
+		"\n"
+		"It has no methods beyond the bare minimum and only exists for its\n"
+		"data members";
+
+static char parent_doc[] = "This represents the parent of this node. On the root node\n"
+		"of the config tree it will be None.\n";
+
+static char key_doc[] = "This is the keyword of this item, ie the first word of any\n"
+		"given line in the config file. It will always be a string.\n";
+
+static char values_doc[] = "This is a tuple (which might be empty) of all value, ie words\n"
+		"following the keyword in any given line in the config file.\n"
+		"\n"
+		"Every item in this tuple will be either a string or a float or a bool,\n"
+		"depending on the contents of the configuration file.\n";
+
+static char children_doc[] = "This is a tuple of child nodes. For most nodes this will be\n"
+		"empty. If this node represents a block instead of a single line of the config\n"
+		"file it will contain all nodes in this block.\n";
+
 static PyObject *Config_new(PyTypeObject *type, PyObject *args, PyObject *kwds) {
 	Config *self;
 	
@@ -92,10 +141,10 @@ static void Config_dealloc(PyObject *self) {
 }
 
 static PyMemberDef Config_members[] = {
-	{"Parent", T_OBJECT, offsetof(Config, parent), 0, "Parent node"},
-	{"Key", T_OBJECT_EX, offsetof(Config, key), 0, "Keyword of this node"},
-	{"Values", T_OBJECT_EX, offsetof(Config, values), 0, "Values after the key"},
-	{"Children", T_OBJECT_EX, offsetof(Config, children), 0, "Childnodes of this node"},
+	{"parent", T_OBJECT, offsetof(Config, parent), 0, parent_doc},
+	{"key", T_OBJECT_EX, offsetof(Config, key), 0, key_doc},
+	{"values", T_OBJECT_EX, offsetof(Config, values), 0, values_doc},
+	{"children", T_OBJECT_EX, offsetof(Config, children), 0, children_doc},
 	{NULL}
 };
 
@@ -121,7 +170,7 @@ PyTypeObject ConfigType = {
 	0,                         /* tp_setattro */
 	0,                         /* tp_as_buffer */
 	Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE | Py_TPFLAGS_HAVE_GC, /*tp_flags*/
-	"Cool help text later",    /* tp_doc */
+	config_doc,                /* tp_doc */
 	Config_traverse,           /* tp_traverse */
 	Config_clear,              /* tp_clear */
 	0,                         /* tp_richcompare */