summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMarc Schink <swo-dev@marcschink.de>2017-03-13 19:11:55 +0100
committerMarc Schink <swo-dev@marcschink.de>2017-03-13 19:24:01 +0100
commitfe4a6d2e7a807dada93eb5806b36bff2857150a6 (patch)
tree87fae1e73dad7d665c7aef4a293dc40b0d18c975
parent6e91555c329b4f387fd9171070d9b9714954815d (diff)
Minor documentation fixes
-rw-r--r--libswo/error.c6
-rw-r--r--libswo/libswo.h6
2 files changed, 9 insertions, 3 deletions
diff --git a/libswo/error.c b/libswo/error.c
index b0d7efa..46bbe81 100644
--- a/libswo/error.c
+++ b/libswo/error.c
@@ -28,7 +28,8 @@
/**
* Return a human-readable description of a libswo error code.
*
- * @param error_code A libswo error code. See #libswo_error for valid values.
+ * @param[in] error_code A libswo error code. See #libswo_error for valid
+ * values.
*
* @return A string which contains a description of the given error code, or
* the string <i>unknown error</i> if the error code is not known. The
@@ -56,7 +57,8 @@ LIBSWO_API const char *libswo_strerror(int error_code)
/**
* Return the name of a libswo error code.
*
- * @param error_code A libswo error code. See #libswo_error for valid values.
+ * @param[in] error_code A libswo error code. See #libswo_error for valid
+ * values.
*
* @return A string which contains the name of the given error code, or the
* string <i>unknown error code</i> if the error code is not known. The
diff --git a/libswo/libswo.h b/libswo/libswo.h
index 5ea3687..051c9d1 100644
--- a/libswo/libswo.h
+++ b/libswo/libswo.h
@@ -373,7 +373,11 @@ struct libswo_packet_dwt_pc_sample {
uint32_t value;
/** Indicates whether the processor is in sleep mode. */
bool sleep;
- /** Program counter (PC) value. */
+ /**
+ * Program counter (PC) value.
+ *
+ * The value is zero if the processor is in sleep mode.
+ */
uint32_t pc;
};