summaryrefslogtreecommitdiff
path: root/plugins/javadesc
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/javadesc
parent9ce85bcdf8da124ad9538875f945ab5c4bb09e1e (diff)
Refreshed the Python documentation for the demanglers.
Diffstat (limited to 'plugins/javadesc')
-rw-r--r--plugins/javadesc/python/demangler.c15
1 files changed, 14 insertions, 1 deletions
diff --git a/plugins/javadesc/python/demangler.c b/plugins/javadesc/python/demangler.c
index a62ca99..b437c5b 100644
--- a/plugins/javadesc/python/demangler.c
+++ b/plugins/javadesc/python/demangler.c
@@ -60,6 +60,19 @@ static PyObject *py_java_demangler_new(PyTypeObject *type, PyObject *args, PyObj
PyObject *result; /* Instance à retourner */
GCompDemangler *demangler; /* Instance à transposer */
+#define JAVA_DEMANGLER_DOC \
+ "JavaDemangler is an implementation of a demangler suitable for processing" \
+ " JVM files.\n" \
+ "\n" \
+ "Instances can be created using the following constructor:\n" \
+ "\n" \
+ " JavaDemangler()" \
+ "\n" \
+ "The descriptors used in the Java VM are described in the Java" \
+ " specifications ; for instance, for the Java SE 13 Edition, such" \
+ " descriptors definitions are available at:" \
+ " https://docs.oracle.com/javase/specs/jvms/se13/html/jvms-4.html#jvms-4.3."
+
demangler = g_java_demangler_new();
result = pygobject_new(G_OBJECT(demangler));
@@ -102,7 +115,7 @@ PyTypeObject *get_python_java_demangler_type(void)
.tp_flags = Py_TPFLAGS_DEFAULT,
- .tp_doc = "PyChrysalide Java demangler",
+ .tp_doc = JAVA_DEMANGLER_DOC,
.tp_methods = py_java_demangler_methods,
.tp_getset = py_java_demangler_getseters,