diff options
author | Cyrille Bagard <nocbos@gmail.com> | 2020-05-21 20:43:30 (GMT) |
---|---|---|
committer | Cyrille Bagard <nocbos@gmail.com> | 2020-05-21 20:43:30 (GMT) |
commit | d8eb070be32504949ad55fd644d9f1a69df1e05d (patch) | |
tree | 321a2591b67b3131baa514fdfe47ae492f665263 /plugins/pychrysalide/format/module.c | |
parent | 7e5b1add6fdeb74b2356acf8ccf7009f45cfa85e (diff) |
Written a proper documentation for the binary format Python bindings.
Diffstat (limited to 'plugins/pychrysalide/format/module.c')
-rw-r--r-- | plugins/pychrysalide/format/module.c | 9 |
1 files changed, 8 insertions, 1 deletions
diff --git a/plugins/pychrysalide/format/module.c b/plugins/pychrysalide/format/module.c index 48c6822..52dc58b 100644 --- a/plugins/pychrysalide/format/module.c +++ b/plugins/pychrysalide/format/module.c @@ -56,12 +56,19 @@ bool add_format_module(PyObject *super) bool result; /* Bilan à retourner */ PyObject *module; /* Sous-module mis en place */ +#define PYCHRYSALIDE_FORMAT_DOC \ + "This module contains the basic definitions requiered for dealing" \ + " with file formats.\n" \ + "\n" \ + "Support for specific formats (such as ELF files for instance)" \ + " needs extra definitions in a specific module." + static PyModuleDef py_chrysalide_format_module = { .m_base = PyModuleDef_HEAD_INIT, .m_name = "pychrysalide.format", - .m_doc = "Python module for Chrysalide.format", + .m_doc = PYCHRYSALIDE_FORMAT_DOC, .m_size = -1, |