Doxygen: Mark private functions/variables properly.
authorUwe Hermann <uwe@hermann-uwe.de>
Sat, 9 Feb 2013 20:44:11 +0000 (21:44 +0100)
committerUwe Hermann <uwe@hermann-uwe.de>
Sat, 9 Feb 2013 21:11:28 +0000 (22:11 +0100)
controller.c
decoder.c
exception.c
log.c
module_sigrokdecode.c
type_decoder.c
type_logic.c
util.c

index fc303d5e40f9cbe4b3169f348349815fb46bc9fe..44fd6c76e079359e5a9af4a810bc249a4130385c 100644 (file)
@@ -92,6 +92,8 @@ static GSList *di_list = NULL;
 /* List of frontend callbacks to receive decoder output. */
 static GSList *callbacks = NULL;
 
+/** @cond PRIVATE */
+
 /* decoder.c */
 extern SRD_PRIV GSList *pd_list;
 
@@ -102,6 +104,8 @@ extern PyMODINIT_FUNC PyInit_sigrokdecode(void);
 /* type_logic.c */
 extern SRD_PRIV PyTypeObject srd_logic_type;
 
+/** @endcond */
+
 /**
  * Initialize libsigrokdecode.
  *
@@ -205,6 +209,8 @@ SRD_API int srd_exit(void)
  *             be added to the Python sys.path, or NULL.
  *
  * @return SRD_OK upon success, a (negative) error code otherwise.
+ *
+ * @private
  */
 SRD_PRIV int srd_decoder_searchpath_add(const char *path)
 {
@@ -619,6 +625,8 @@ SRD_API struct srd_decoder_inst *srd_inst_find_by_id(const char *inst_id)
  * @param obj The Python class instantiation.
  *
  * @return Pointer to struct srd_decoder_inst, or NULL if not found.
+ *
+ * @private
  */
 SRD_PRIV struct srd_decoder_inst *srd_inst_find_by_obj(const GSList *stack,
                                                       const PyObject *obj)
@@ -639,6 +647,7 @@ SRD_PRIV struct srd_decoder_inst *srd_inst_find_by_obj(const GSList *stack,
        return di;
 }
 
+/** @private */
 SRD_PRIV int srd_inst_start(struct srd_decoder_inst *di, PyObject *args)
 {
        PyObject *py_name, *py_res;
@@ -688,6 +697,8 @@ SRD_PRIV int srd_inst_start(struct srd_decoder_inst *di, PyObject *args)
  * @param inbuflen Length of the buffer. Must be > 0.
  *
  * @return SRD_OK upon success, a (negative) error code otherwise.
+ *
+ * @private
  */
 SRD_PRIV int srd_inst_decode(uint64_t start_samplenum,
                             const struct srd_decoder_inst *di,
@@ -742,6 +753,7 @@ SRD_PRIV int srd_inst_decode(uint64_t start_samplenum,
        return SRD_OK;
 }
 
+/** @private */
 SRD_PRIV void srd_inst_free(struct srd_decoder_inst *di)
 {
        GSList *l;
@@ -761,6 +773,7 @@ SRD_PRIV void srd_inst_free(struct srd_decoder_inst *di)
        g_slist_free(di->pd_output);
 }
 
+/** @private */
 SRD_PRIV void srd_inst_free_all(GSList *stack)
 {
        GSList *l;
@@ -886,6 +899,7 @@ SRD_API int srd_pd_output_callback_add(int output_type,
        return SRD_OK;
 }
 
+/** @private */
 SRD_PRIV void *srd_pd_output_callback_find(int output_type)
 {
        GSList *l;
@@ -905,6 +919,7 @@ SRD_PRIV void *srd_pd_output_callback_find(int output_type)
 }
 
 /* This is the backend function to Python sigrokdecode.add() call. */
+/** @private */
 SRD_PRIV int srd_inst_pd_output_add(struct srd_decoder_inst *di,
                                    int output_type, const char *proto_id)
 {
index cbca0b840376c60de504dcc1bd91cdd449c6bef4..52c913aeea0ad6bec6e9f876c4ee93714a112818 100644 (file)
--- a/decoder.c
+++ b/decoder.c
 #include "sigrokdecode-internal.h"
 #include <glib.h>
 
+/** @cond PRIVATE */
+
 /* The list of protocol decoders. */
 SRD_PRIV GSList *pd_list = NULL;
 
 /* module_sigrokdecode.c */
 extern SRD_PRIV PyObject *mod_sigrokdecode;
 
+/** @endcond */
+
 /**
  * Returns the list of supported/loaded protocol decoders.
  *
index 0c248e169e4c4b45502a8d781df86b532e47801c..1c50321c2faa452555a734c2721ee5629b17d7a4 100644 (file)
@@ -24,6 +24,7 @@
 #include <glib.h>
 #include <frameobject.h> /* Python header not pulled in by default. */
 
+/** @private */
 SRD_PRIV void srd_exception_catch(const char *format, ...)
 {
        PyObject *etype, *evalue, *etb, *py_str;
diff --git a/log.c b/log.c
index 81e9251ba06a9d4d8a74cfe6130b4e13efc2c454..d6df1564126a17c049b3bed2672998a632b8a05e 100644 (file)
--- a/log.c
+++ b/log.c
@@ -40,8 +40,10 @@ static srd_log_callback_t srd_log_callback = srd_logv;
 static void *srd_log_callback_data = NULL;
 
 /* Log domain (a short string that is used as prefix for all messages). */
+/** @cond PRIVATE */
 #define LOGDOMAIN_MAXLEN 30
 #define LOGDOMAIN_DEFAULT "srd: "
+/** @endcond */
 static char srd_log_domain[LOGDOMAIN_MAXLEN + 1] = LOGDOMAIN_DEFAULT;
 
 /**
@@ -193,6 +195,7 @@ static int srd_logv(void *cb_data, int loglevel, const char *format,
        return ret;
 }
 
+/** @private */
 SRD_PRIV int srd_log(int loglevel, const char *format, ...)
 {
        int ret;
@@ -205,6 +208,7 @@ SRD_PRIV int srd_log(int loglevel, const char *format, ...)
        return ret;
 }
 
+/** @private */
 SRD_PRIV int srd_spew(const char *format, ...)
 {
        int ret;
@@ -218,6 +222,7 @@ SRD_PRIV int srd_spew(const char *format, ...)
        return ret;
 }
 
+/** @private */
 SRD_PRIV int srd_dbg(const char *format, ...)
 {
        int ret;
@@ -231,6 +236,7 @@ SRD_PRIV int srd_dbg(const char *format, ...)
        return ret;
 }
 
+/** @private */
 SRD_PRIV int srd_info(const char *format, ...)
 {
        int ret;
@@ -244,6 +250,7 @@ SRD_PRIV int srd_info(const char *format, ...)
        return ret;
 }
 
+/** @private */
 SRD_PRIV int srd_warn(const char *format, ...)
 {
        int ret;
@@ -257,6 +264,7 @@ SRD_PRIV int srd_warn(const char *format, ...)
        return ret;
 }
 
+/** @private */
 SRD_PRIV int srd_err(const char *format, ...)
 {
        int ret;
index a76645c582c6e205912d03d6f4299eb069551303..00644ccfa05b9d2bfbb7d65fefd48c7e12bc8a98 100644 (file)
@@ -21,6 +21,8 @@
 #include "sigrokdecode-internal.h"
 #include "config.h"
 
+/** @cond PRIVATE */
+
 /* type_decoder.c */
 extern SRD_PRIV PyTypeObject srd_Decoder_type;
 
@@ -33,6 +35,8 @@ extern SRD_PRIV PyTypeObject srd_logic_type;
  */
 SRD_PRIV PyObject *mod_sigrokdecode = NULL;
 
+/** @endcond */
+
 static struct PyModuleDef sigrokdecode_module = {
        PyModuleDef_HEAD_INIT,
        .m_name = "sigrokdecode",
@@ -40,6 +44,7 @@ static struct PyModuleDef sigrokdecode_module = {
        .m_size = -1,
 };
 
+/** @cond PRIVATE */
 /* FIXME: SRD_PRIV causes issues on MinGW. Investigate. */
 PyMODINIT_FUNC PyInit_sigrokdecode(void)
 {
@@ -78,3 +83,4 @@ PyMODINIT_FUNC PyInit_sigrokdecode(void)
 
        return mod;
 }
+/** @endcond */
index 9cf77708dee62982fe6117db67f15afaab1767aa..076978ca9726fdb31acc9de05037c16bd02c7760 100644 (file)
@@ -209,6 +209,7 @@ static PyMethodDef Decoder_methods[] = {
        {NULL, NULL, 0, NULL}
 };
 
+/** @cond PRIVATE */
 SRD_PRIV PyTypeObject srd_Decoder_type = {
        PyVarObject_HEAD_INIT(NULL, 0)
        .tp_name = "sigrokdecode.Decoder",
@@ -217,3 +218,4 @@ SRD_PRIV PyTypeObject srd_Decoder_type = {
        .tp_doc = "sigrok Decoder base class",
        .tp_methods = Decoder_methods,
 };
+/** @endcond */
index 098e34d84d3af9d1471fa936ec17a0cec254efa2..ded0062456467658f8645353c89e0a1671c30a93 100644 (file)
@@ -80,6 +80,7 @@ static PyObject *srd_logic_iternext(PyObject *self)
        return logic->sample;
 }
 
+/** @cond PRIVATE */
 SRD_PRIV PyTypeObject srd_logic_type = {
        PyVarObject_HEAD_INIT(NULL, 0)
        .tp_name = "srd_logic",
@@ -89,3 +90,4 @@ SRD_PRIV PyTypeObject srd_logic_type = {
        .tp_iter = srd_logic_iter,
        .tp_iternext = srd_logic_iternext,
 };
+/** @endcond */
diff --git a/util.c b/util.c
index ed31e9749ffec0e6e295110e8b19e69fa51b8b3c..0112efa39847c8e717387d21e7d7d3827a6680a9 100644 (file)
--- a/util.c
+++ b/util.c
@@ -32,6 +32,8 @@
  *
  * @return SRD_OK upon success, a (negative) error code otherwise.
  *         The 'outstr' argument points to a malloc()ed string upon success.
+ *
+ * @private
  */
 SRD_PRIV int py_attr_as_str(const PyObject *py_obj, const char *attr,
                            char **outstr)
@@ -73,6 +75,8 @@ SRD_PRIV int py_attr_as_str(const PyObject *py_obj, const char *attr,
  *
  * @return SRD_OK upon success, a (negative) error code otherwise.
  *         The 'outstr' argument points to a malloc()ed string upon success.
+ *
+ * @private
  */
 SRD_PRIV int py_dictitem_as_str(const PyObject *py_obj, const char *key,
                                char **outstr)
@@ -111,6 +115,8 @@ SRD_PRIV int py_dictitem_as_str(const PyObject *py_obj, const char *key,
  *
  * @return SRD_OK upon success, a (negative) error code otherwise.
  *         The 'outstr' argument points to a malloc()ed string upon success.
+ *
+ * @private
  */
 SRD_PRIV int py_str_as_str(const PyObject *py_str, char **outstr)
 {
@@ -165,6 +171,8 @@ err_out:
  *
  * @return SRD_OK upon success, a (negative) error code otherwise.
  *         The 'outstr' argument points to a g_malloc()ed char** upon success.
+ *
+ * @private
  */
 SRD_PRIV int py_strlist_to_char(const PyObject *py_strlist, char ***outstr)
 {