]> sigrok.org Git - libsigrok.git/commitdiff
Doxygen consistency fixes (@foo instead of \foo).
authorUwe Hermann <redacted>
Wed, 5 Aug 2015 15:23:54 +0000 (17:23 +0200)
committerUwe Hermann <redacted>
Sat, 15 Aug 2015 15:19:42 +0000 (17:19 +0200)
include/libsigrok/libsigrok.h
src/hardware/motech-lps-30x/api.c
src/input/input.c

index 233e04a6ce969dd881c02f3c6d5092536e9a356e..356739cc05a8f9bcb15df1923c8e82b0475dcc90 100644 (file)
@@ -1023,13 +1023,13 @@ struct sr_dev_driver {
        int (*cleanup) (const struct sr_dev_driver *driver);
        /** Scan for devices. Driver should do all initialisation required.
         *  Can be called several times, e.g. with different port options.
-        *  \retval NULL Error or no devices found.
-        *  \retval other GSList of a struct sr_dev_inst for each device.
+        *  @retval NULL Error or no devices found.
+        *  @retval other GSList of a struct sr_dev_inst for each device.
         *                Must be freed by caller!
         */
        GSList *(*scan) (struct sr_dev_driver *driver, GSList *options);
        /** Get list of device instances the driver knows about.
-        *  \returns NULL or GSList of a struct sr_dev_inst for each device.
+        *  @returns NULL or GSList of a struct sr_dev_inst for each device.
         *           Must not be freed by caller!
         */
        GSList *(*dev_list) (const struct sr_dev_driver *driver);
index ba647837caf58079f32266b8e9d14d833df01997..1b1eaf17a3243c188d575e7082137add16b0a0b9 100644 (file)
@@ -201,7 +201,7 @@ SR_PRIV int lps_cmd_ok(struct sr_serial_dev_inst *serial, const char* fmt, ...)
 }
 
 /** Send command and read reply string.
- *  \param reply Pointer to buffer of size LINELEN_MAX. Will be NUL-terminated.
+ *  @param reply Pointer to buffer of size LINELEN_MAX. Will be NUL-terminated.
  */
 SR_PRIV int lps_cmd_reply(char* reply, struct sr_serial_dev_inst *serial, const char* fmt, ...)
 {
@@ -314,8 +314,8 @@ static gint64 calc_timeout_ms(gint64 start_us)
 }
 
 /** Read message into buf until "OK" received.
- *  \retval SR_OK Msg received; buf and buflen contain result, if any except OK.
- *  \retval SR_ERR Error, including timeout.
+ *  @retval SR_OK Msg received; buf and buflen contain result, if any except OK.
+ *  @retval SR_ERR Error, including timeout.
 */
 SR_PRIV int lps_read_reply(struct sr_serial_dev_inst *serial, char **buf, int *buflen)
 {
index b078f5a6bf4febac814d9b0375243ad3f2271869..4b36c887c45028db3c1a2b3030c8c94ebd58a3a7 100644 (file)
@@ -233,7 +233,7 @@ SR_API void sr_input_options_free(const struct sr_option **options)
  *
  * @param imod The input module to use. Must not be NULL.
  * @param options GHashTable consisting of keys corresponding with
- * the module options \c id field. The values should be GVariant
+ * the module options @c id field. The values should be GVariant
  * pointers with sunk references, of the same GVariantType as the option's
  * default value.
  *