Doxygen: Add @file items for the relevant files.

[libsigrokdecode.git] / module_sigrokdecode.c

diff --git a/module_sigrokdecode.c b/module_sigrokdecode.c
index 1cbcc40353c1759dba473858e9f9a289a027aa5a..00644ccfa05b9d2bfbb7d65fefd48c7e12bc8a98 100644 (file)
--- a/module_sigrokdecode.c
+++ b/module_sigrokdecode.c
@@ -21,6 +21,8 @@
 #include "sigrokdecode-internal.h"
 #include "config.h"
 
+/** @cond PRIVATE */
+
 /* type_decoder.c */
 extern SRD_PRIV PyTypeObject srd_Decoder_type;
 
@@ -28,11 +30,13 @@ extern SRD_PRIV PyTypeObject srd_Decoder_type;
 extern SRD_PRIV PyTypeObject srd_logic_type;
 
 /*
- * When initialized, a reference to this module inside the python interpreter
+ * When initialized, a reference to this module inside the Python interpreter
  * lives here.
  */
 SRD_PRIV PyObject *mod_sigrokdecode = NULL;
 
+/** @endcond */
+
 static struct PyModuleDef sigrokdecode_module = {
        PyModuleDef_HEAD_INIT,
        .m_name = "sigrokdecode",
@@ -40,11 +44,13 @@ static struct PyModuleDef sigrokdecode_module = {
        .m_size = -1,
 };
 
-SRD_PRIV PyMODINIT_FUNC PyInit_sigrokdecode(void)
+/** @cond PRIVATE */
+/* FIXME: SRD_PRIV causes issues on MinGW. Investigate. */
+PyMODINIT_FUNC PyInit_sigrokdecode(void)
 {
        PyObject *mod;
 
-       /* tp_new needs to be assigned here for compiler portability */
+       /* tp_new needs to be assigned here for compiler portability. */
        srd_Decoder_type.tp_new = PyType_GenericNew;
        if (PyType_Ready(&srd_Decoder_type) < 0)
                return NULL;
@@ -77,3 +83,4 @@ SRD_PRIV PyMODINIT_FUNC PyInit_sigrokdecode(void)
 
        return mod;
 }
+/** @endcond */