From 1307580ca1ca820b57dcfbfcdcee9afe74cc1614 Mon Sep 17 00:00:00 2001
From: Cyrille Bagard <nocbos@gmail.com>
Date: Fri, 31 Aug 2018 01:02:44 +0200
Subject: Fixed some Python method signatures.
---
plugins/elf/python/format.c | 2 +-
plugins/pychrysalide/arch/vmpa.c | 7 ++--
plugins/pychrysalide/core/params.c | 2 +-
plugins/pychrysalide/glibext/configuration.c | 56 ++++++++++++++++------------
plugins/pychrysalide/gui/editem.c | 8 ++--
5 files changed, 42 insertions(+), 33 deletions(-)
diff --git a/plugins/elf/python/format.c b/plugins/elf/python/format.c
index 6c1b12f..4e2b7cc 100644
--- a/plugins/elf/python/format.c
+++ b/plugins/elf/python/format.c
@@ -180,7 +180,7 @@ PyTypeObject *get_python_elf_format_type(void)
{
"find_dynamic_item_by_index", py_elf_format_find_dynamic_item_by_index,
METH_VARARGS,
- "find_dynamic_item_by_type($self, type, /)\n--\n\nFind an item from the dynamic segment using a given index."
+ "find_dynamic_item_by_index($self, type, /)\n--\n\nFind an item from the dynamic segment using a given index."
},
{ NULL }
};
diff --git a/plugins/pychrysalide/arch/vmpa.c b/plugins/pychrysalide/arch/vmpa.c
index 70d9364..c226224 100644
--- a/plugins/pychrysalide/arch/vmpa.c
+++ b/plugins/pychrysalide/arch/vmpa.c
@@ -1166,9 +1166,10 @@ static PyObject *py_mrange_new(PyTypeObject *type, PyObject *args, PyObject *kwd
PyTypeObject *get_python_mrange_type(void)
{
static PyMethodDef py_mrange_methods[] = {
- { "contains", py_mrange_contains,
- METH_VARARGS,
- "contains($self, other, /)\n--\nTell if the current range contains another given range or address."
+ {
+ "contains", py_mrange_contains,
+ METH_VARARGS,
+ "contains($self, other, /)\n--\n\nTell if the current range contains another given range or address."
},
#if 0
{ "read_u8", py_arch_instruction_read_u8,
diff --git a/plugins/pychrysalide/core/params.c b/plugins/pychrysalide/core/params.c
index 4a55a2b..94d55b1 100644
--- a/plugins/pychrysalide/core/params.c
+++ b/plugins/pychrysalide/core/params.c
@@ -90,7 +90,7 @@ PyTypeObject *get_python_params_type(void)
{ "get_main_configuration", py_params_get_main_configuration,
METH_NOARGS | METH_STATIC,
- "Give access to the main configuration of Chrysalide."
+ "get_main_configuration(, /)\n--\n\nGive access to the main configuration of Chrysalide."
},
{ NULL }
diff --git a/plugins/pychrysalide/glibext/configuration.c b/plugins/pychrysalide/glibext/configuration.c
index eb725ff..18d681f 100644
--- a/plugins/pychrysalide/glibext/configuration.c
+++ b/plugins/pychrysalide/glibext/configuration.c
@@ -476,13 +476,15 @@ static int py_config_param_set_value(PyObject *self, PyObject *value, void *clos
PyTypeObject *get_python_config_param_type(void)
{
static PyMethodDef py_config_param_methods[] = {
- { "make_empty", py_config_param_make_empty,
- METH_NOARGS,
- "Unset the value of the current parameter."
+ {
+ "make_empty", py_config_param_make_empty,
+ METH_NOARGS,
+ "make_empty($self, /)\n--\n\nUnset the value of the current parameter."
},
- { "reset", py_config_param_reset,
- METH_NOARGS,
- "Reset the content of the current parameter."
+ {
+ "reset", py_config_param_reset,
+ METH_NOARGS,
+ "reset($self, /)\n--\n\nReset the content of the current parameter."
},
{ NULL }
};
@@ -1096,29 +1098,35 @@ static PyObject *py_generic_config_get_filename(PyObject *self, void *closure)
PyTypeObject *get_python_generic_config_type(void)
{
static PyMethodDef py_generic_config_methods[] = {
- { "read", py_generic_config_read,
- METH_NOARGS,
- "Read the configuration from its relative XML file."
+ {
+ "read", py_generic_config_read,
+ METH_NOARGS,
+ "read(, /)\n--\n\nRead the configuration from its relative XML file."
},
- { "write", py_generic_config_write,
- METH_NOARGS,
- "Write the configuration to its relative XML file."
+ {
+ "write", py_generic_config_write,
+ METH_NOARGS,
+ "write(, /)\n--\n\nWrite the configuration to its relative XML file."
},
- { "search", py_generic_config_search,
- METH_VARARGS,
- "Look for a given configuration parameter."
+ {
+ "search", py_generic_config_search,
+ METH_VARARGS,
+ "search($self, path, /)\n--\n\nLook for a given configuration parameter."
},
- { "add", py_generic_config_add,
- METH_VARARGS,
- "Add an existing parameter to a configuration."
+ {
+ "add", py_generic_config_add,
+ METH_VARARGS,
+ "add($self, param, /)\n--\n\nAdd an existing parameter to a configuration."
},
- { "delete", py_generic_config_delete,
- METH_VARARGS,
- "Delete an existing parameter from a configuration."
+ {
+ "delete", py_generic_config_delete,
+ METH_VARARGS,
+ "delete($self, path, /)\n--\n\nDelete an existing parameter from a configuration."
},
- { "params", py_generic_config_list_params,
- METH_NOARGS,
- "List all registered configuration parameters."
+ {
+ "params", py_generic_config_list_params,
+ METH_NOARGS,
+ "params($self, /)\n--\n\nList all registered configuration parameters."
},
{ NULL }
};
diff --git a/plugins/pychrysalide/gui/editem.c b/plugins/pychrysalide/gui/editem.c
index 03ad97a..68a0829 100644
--- a/plugins/pychrysalide/gui/editem.c
+++ b/plugins/pychrysalide/gui/editem.c
@@ -300,22 +300,22 @@ PyTypeObject *get_python_editor_item_type(void)
{
"change_content", (PyCFunction)py_editor_item_change_content,
METH_VARARGS,
- "Called by Chrysalide on each content change, if the item is registered."
+ "change_content($self, /)\n--\n\nCalled by Chrysalide on each content change, if the item is registered."
},
{
"change_view", (PyCFunction)py_editor_item_change_view,
METH_VARARGS,
- "Called by Chrysalide on each view change, if the item is registered."
+ "change_view($self, /)\n--\n\nCalled by Chrysalide on each view change, if the item is registered."
},
{
"update_view", (PyCFunction)py_editor_item_update_view,
METH_VARARGS,
- "Called by Chrysalide on each view content change, if the item is registered."
+ "update_view($self, /)\n--\n\nCalled by Chrysalide on each view content change, if the item is registered."
},
{
"register", (PyCFunction)py_editor_item_register,
METH_NOARGS,
- "register($self, /)\n--\n\nRegister the item as editor item."
+ "register($self, /)\n--\n\nregister($self, /)\n--\n\nRegister the item as editor item."
},
{ NULL }
};
--
cgit v0.11.2-87-g4458