From: Uwe Hermann Date: Mon, 12 Jun 2017 00:44:28 +0000 (+0200) Subject: Various Doxygen fixes. X-Git-Tag: libsigrok-0.5.0~3 X-Git-Url: https://sigrok.org/gitaction?a=commitdiff_plain;h=f200d59ee21a42998752c4319d4ff48e129c95c5;p=libsigrok.git Various Doxygen fixes. --- diff --git a/Doxyfile b/Doxyfile index 2ffff8c8..51b9c2bd 100644 --- a/Doxyfile +++ b/Doxyfile @@ -781,6 +781,7 @@ RECURSIVE = YES EXCLUDE = config.h src/libsigrok-internal.h src/session_driver.c EXCLUDE += src/std.c src/drivers.c src/ezusb.c src/fallback.c EXCLUDE += src/soft-trigger.c src/usb.c src/sw_limits.c +EXCLUDE += src/scpi.h # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or # directories that are symbolic links (a Unix file system feature) are excluded @@ -807,6 +808,8 @@ EXCLUDE_SYMLINKS = NO # - src/fallback.c: Fallback functions to API calls from serial.c. # - src/soft-trigger.c: Non-public helpers, no public API stuff in there. # - src/usb.c: Non-public helpers, no public API stuff in there. +# - src/sw_limits.c: Non-public helpers, no public API stuff in there. +# - src/scpi.h: Non-public helpers, no public API stuff in there. # - src/hardware/*: Only driver-specific stuff, no public API stuff in there. # - src/input/*: Only input.c contains public API, everything else doesn't. # - src/output/*: Only output.c contains public API, everything else doesn't. @@ -814,12 +817,15 @@ EXCLUDE_SYMLINKS = NO # - src/scpi/*: Non-public helpers, no public API stuff in there. # - src/dmm/*: Non-public helpers, no public API stuff in there. # - src/lcr/*: Non-public helpers, no public API stuff in there. +# - src/modbus/*: Non-public helpers, no public API stuff in there. +# - src/scale/*: Non-public helpers, no public API stuff in there. # - tests/*: Unit tests, no public API stuff in there. # - bindings/*: Language bindings, no public API stuff in there. # - doxy/*: Potentially already generated docs, should not be scanned. # EXCLUDE_PATTERNS = */src/hardware/* */src/input/* */src/output/* */src/transform/* EXCLUDE_PATTERNS += */src/scpi/* */src/dmm/* */src/lcr/* +EXCLUDE_PATTERNS += */src/modbus/* */src/scale/* EXCLUDE_PATTERNS += */src/tests/* */src/bindings/* */src/doxy/* INPUT += src/input/input.c src/output/output.c INPUT += src/transform/transform.c diff --git a/src/analog.c b/src/analog.c index 9bc88b31..9fdece5d 100644 --- a/src/analog.c +++ b/src/analog.c @@ -119,6 +119,7 @@ static struct unit_mq_string mq_strings[] = { ALL_ZERO }; +/** @private */ SR_PRIV int sr_analog_init(struct sr_datafeed_analog *analog, struct sr_analog_encoding *encoding, struct sr_analog_meaning *meaning, @@ -306,8 +307,10 @@ SR_API int sr_analog_to_float(const struct sr_datafeed_analog *analog, */ SR_API const char *sr_analog_si_prefix(float *value, int *digits) { +/** @cond PRIVATE */ #define NEG_PREFIX_COUNT 5 /* number of prefixes below unity */ #define POS_PREFIX_COUNT (int)(ARRAY_SIZE(prefixes) - NEG_PREFIX_COUNT - 1) +/** @endcond */ static const char *prefixes[] = { "f", "p", "n", "µ", "m", "", "k", "M", "G", "T" }; if (!value || !digits || isnan(*value)) diff --git a/src/device.c b/src/device.c index d87d2904..aa499c8d 100644 --- a/src/device.c +++ b/src/device.c @@ -136,7 +136,9 @@ SR_API int sr_dev_channel_enable(struct sr_channel *channel, gboolean state) } /* Returns the next enabled channel, wrapping around if necessary. */ +/** @private */ SR_PRIV struct sr_channel *sr_next_enabled_channel(const struct sr_dev_inst *sdi, + struct sr_channel *cur_channel) { struct sr_channel *next_channel; diff --git a/src/hwdriver.c b/src/hwdriver.c index c747c4f4..deff5a7b 100644 --- a/src/hwdriver.c +++ b/src/hwdriver.c @@ -287,6 +287,7 @@ static struct sr_key_info sr_key_info_mqflag[] = { }; /* This must handle all the keys from enum sr_datatype (libsigrok.h). */ +/** @private */ SR_PRIV const GVariantType *sr_variant_type_get(int datatype) { switch (datatype) { @@ -314,6 +315,7 @@ SR_PRIV const GVariantType *sr_variant_type_get(int datatype) } } +/** @private */ SR_PRIV int sr_variant_type_check(uint32_t key, GVariant *value) { const struct sr_key_info *info; diff --git a/src/log.c b/src/log.c index 03dd21f0..cdf2293b 100644 --- a/src/log.c +++ b/src/log.c @@ -24,7 +24,9 @@ #include #include "libsigrok-internal.h" +/** @cond PRIVATE */ #define LOG_PREFIX "log" +/** @endcond */ /** * @file diff --git a/src/session.c b/src/session.c index 50bad8be..c88e48c7 100644 --- a/src/session.c +++ b/src/session.c @@ -1189,6 +1189,7 @@ SR_PRIV int sr_session_source_add_internal(struct sr_session *session, return SR_OK; } +/** @private */ SR_PRIV int sr_session_fd_source_add(struct sr_session *session, void *key, gintptr fd, int events, int timeout, sr_receive_data_callback cb, void *cb_data) @@ -1450,6 +1451,7 @@ static void copy_src(struct sr_config *src, struct sr_datafeed_meta *meta_copy) g_memdup(src, sizeof(struct sr_config))); } +/** @private */ SR_PRIV int sr_packet_copy(const struct sr_datafeed_packet *packet, struct sr_datafeed_packet **copy) { diff --git a/src/session_file.c b/src/session_file.c index 9f5c5157..663fea72 100644 --- a/src/session_file.c +++ b/src/session_file.c @@ -47,8 +47,8 @@ extern SR_PRIV struct sr_dev_driver session_driver; static int session_driver_initialized = 0; #if !HAVE_ZIP_DISCARD -/* Replacement for zip_discard() if it isn't available. - */ +/* Replacement for zip_discard() if it isn't available. */ +/** @private */ SR_PRIV void sr_zip_discard(struct zip *archive) { if (zip_unchange_all(archive) < 0 || zip_close(archive) < 0) @@ -56,10 +56,15 @@ SR_PRIV void sr_zip_discard(struct zip *archive) } #endif -/** Read metadata entries from a session archive. +/** + * Read metadata entries from a session archive. + * * @param[in] archive An open ZIP archive. * @param[in] entry Stat buffer filled in for the metadata archive member. + * * @return A new key/value store containing the session metadata. + * + * @private */ SR_PRIV GKeyFile *sr_sessionfile_read_metadata(struct zip *archive, const struct zip_stat *entry) @@ -162,7 +167,8 @@ SR_PRIV int sr_sessionfile_check(const char *filename) return SR_OK; } - + +/** @private */ SR_PRIV struct sr_dev_inst *sr_session_prepare_sdi(const char *filename, struct sr_session **session) { struct sr_dev_inst *sdi = NULL;