From 57790bc8c558ccf2e57b3d973c043088232628c7 Mon Sep 17 00:00:00 2001 From: Uwe Hermann Date: Sat, 9 Feb 2013 21:44:11 +0100 Subject: [PATCH] Doxygen: Mark private functions/variables properly. --- controller.c | 15 +++++++++++++++ decoder.c | 4 ++++ exception.c | 1 + log.c | 8 ++++++++ module_sigrokdecode.c | 6 ++++++ type_decoder.c | 2 ++ type_logic.c | 2 ++ util.c | 8 ++++++++ 8 files changed, 46 insertions(+) diff --git a/controller.c b/controller.c index fc303d5..44fd6c7 100644 --- a/controller.c +++ b/controller.c @@ -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) { diff --git a/decoder.c b/decoder.c index cbca0b8..52c913a 100644 --- a/decoder.c +++ b/decoder.c @@ -23,12 +23,16 @@ #include "sigrokdecode-internal.h" #include +/** @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. * diff --git a/exception.c b/exception.c index 0c248e1..1c50321 100644 --- a/exception.c +++ b/exception.c @@ -24,6 +24,7 @@ #include #include /* 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 81e9251..d6df156 100644 --- 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; diff --git a/module_sigrokdecode.c b/module_sigrokdecode.c index a76645c..00644cc 100644 --- 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; @@ -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 */ diff --git a/type_decoder.c b/type_decoder.c index 9cf7770..076978c 100644 --- a/type_decoder.c +++ b/type_decoder.c @@ -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 */ diff --git a/type_logic.c b/type_logic.c index 098e34d..ded0062 100644 --- a/type_logic.c +++ b/type_logic.c @@ -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 ed31e97..0112efa 100644 --- 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) { -- 2.30.2