summaryrefslogtreecommitdiff
path: root/plugins/pychrysalide/mangling/module.c
diff options
context:
space:
mode:
authorCyrille Bagard <nocbos@gmail.com>2020-01-05 23:04:45 (GMT)
committerCyrille Bagard <nocbos@gmail.com>2020-01-05 23:04:45 (GMT)
commit24398cb372624bf281ee4d9eb07f2a076b3cc664 (patch)
treee5fab56d61b9a03fb8dd56e63b56c3ee404ac490 /plugins/pychrysalide/mangling/module.c
parent9ce85bcdf8da124ad9538875f945ab5c4bb09e1e (diff)
Refreshed the Python documentation for the demanglers.
Diffstat (limited to 'plugins/pychrysalide/mangling/module.c')
-rw-r--r--plugins/pychrysalide/mangling/module.c11
1 files changed, 10 insertions, 1 deletions
diff --git a/plugins/pychrysalide/mangling/module.c b/plugins/pychrysalide/mangling/module.c
index 2b2aef7..fe9487e 100644
--- a/plugins/pychrysalide/mangling/module.c
+++ b/plugins/pychrysalide/mangling/module.c
@@ -50,12 +50,21 @@ bool add_mangling_module(PyObject *super)
bool result; /* Bilan à retourner */
PyObject *module; /* Sous-module mis en place */
+#define PYCHRYSALIDE_MANGLING_DOC \
+ "This module provides facilities to decode function or type names" \
+ " mangled by a compiler.\n" \
+ "\n" \
+ "The benefit of using these facilities instead of external tools such" \
+ " as *c++filt* resides in the quantity of recovered information: not" \
+ " only the mangled name is restored in a human readable form, but all" \
+ " the involved inner types get available for further processing."
+
static PyModuleDef py_chrysalide_mangling_module = {
.m_base = PyModuleDef_HEAD_INIT,
.m_name = "pychrysalide.mangling",
- .m_doc = "Python module for Chrysalide.mangling",
+ .m_doc = PYCHRYSALIDE_MANGLING_DOC,
.m_size = -1,