From abc57815eb9992d489d30fd315f93ded52ebc5a0 Mon Sep 17 00:00:00 2001
From: smathis <stefan.mathis@psi.ch>
Date: Wed, 29 Apr 2026 11:59:44 +0200
Subject: [PATCH] Document what types are possible for get and put

---
 bus/m_epics_ca.h | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)

diff --git a/bus/m_epics_ca.h b/bus/m_epics_ca.h
index ac64ad1..8b3e293 100644
--- a/bus/m_epics_ca.h
+++ b/bus/m_epics_ca.h
@@ -96,6 +96,16 @@ template <typename T> class mEpicsCa {
      * for `T` depending on the record type (for an enum record with `T =
      * uint16_t`, `std::string` is a valid "alias"). The corresponding string or
      * uint value is then put into `value`.
+     *
+     * Supported types for V are:
+     * - `int`
+     * - `short`
+     * - `long`
+     * - `uint16_t`
+     * - `float`
+     * - `double`
+     * - `std::string`
+     * For char arrays, use `mEpicsCa::get(char *buf, u_long len)` instead.
      * @param value Pointer which gets populated with the channel value if
      * reading succeeded.
      * @return int MIDAS status error code as defined in midas.h.
@@ -118,6 +128,16 @@ template <typename T> class mEpicsCa {
      *
      * @tparam V Type of the `value` pointer, which needs to be a valid "alias"
      * for `T`, see `mEpicsCa::get`. This is checked during instantiation.
+     *
+     * Supported types for V are:
+     * - `int`
+     * - `short`
+     * - `long`
+     * - `uint16_t`
+     * - `float`
+     * - `double`
+     * - `std::string`
+     * For char arrays, use `mEpicsCa::put(char *buf, u_long len)` instead.
      * @param value Pointer to the new value which gets written to the channel.
      * @return int MIDAS status error code as defined in midas.h.
      */