DELETEME: merge commit to use refactored files

analogdevicesinc · Aug 21, 2024 · 88f24f5 · 88f24f5
2 parents 08efeec + 8b42898
commit 88f24f5
Show file tree

Hide file tree

Showing 23 changed files with 442 additions and 331 deletions.
diff --git a/bindings/matlab/definelibm2k.m b/bindings/matlab/definelibm2k.m
@@ -2279,7 +2279,7 @@
     "Set the sample rate for both channels", ...
     "DetailedDescription", "This content is from the external library documentation."); % Modify help description values as needed.
 defineArgument(setSampleRateDefinition, "samplerates", "clib.array.libm2k.Double", "Description", "samplerates A list containing the sample rates of each channel");
-defineOutput(setSampleRateDefinition, "RetVal", "clib.array.libm2k.Double", "Description", "A list containing the previously setted sample rates");
+defineOutput(setSampleRateDefinition, "RetVal", "clib.array.libm2k.Double", "Description", "A list containing the previously set sample rates");
 validate(setSampleRateDefinition);
 
 %% C++ class method |setSampleRate| for C++ class |libm2k::analog::M2kAnalogOut| 
@@ -3267,7 +3267,7 @@
     "Description", "getUri Method of C++ class libm2k::context::Context." + newline + ...
     "Get the URI of the current context", ...
     "DetailedDescription", "This content is from the external library documentation."); % Modify help description values as needed.
-defineOutput(getUriDefinition, "RetVal", "string", "Description", "string containt the context URI (ex: ""usb:1.2.3"", ""ip:192.168.2.1"")");
+defineOutput(getUriDefinition, "RetVal", "string", "Description", "string containing the context URI (ex: ""usb:1.2.3"", ""ip:192.168.2.1"")");
 validate(getUriDefinition);
 
 %% C++ class method |getDMM| for C++ class |libm2k::context::Context| 
@@ -3305,7 +3305,7 @@
     "Description", "getAvailableContextAttributes Method of C++ class libm2k::context::Context." + newline + ...
     "Retrieve all the available context attributes", ...
     "DetailedDescription", "This content is from the external library documentation."); % Modify help description values as needed.
-defineOutput(getAvailableContextAttributesDefinition, "RetVal", "clib.array.libm2k.std.String", "Description", "A list of strings containg all the context attributes");
+defineOutput(getAvailableContextAttributesDefinition, "RetVal", "clib.array.libm2k.std.String", "Description", "A list of strings containing all the context attributes");
 validate(getAvailableContextAttributesDefinition);
 
 %% C++ class method |getContextAttributeValue| for C++ class |libm2k::context::Context| 

diff --git a/bindings/matlab/definelibm2k_linux64.m b/bindings/matlab/definelibm2k_linux64.m
@@ -2276,7 +2276,7 @@
     "Set the sample rate for both channels", ...
     "DetailedDescription", "This content is from the external library documentation."); % Modify help description values as needed.
 defineArgument(setSampleRateDefinition, "samplerates", "clib.array.libm2k.Double", "Description", "samplerates A list containing the sample rates of each channel");
-defineOutput(setSampleRateDefinition, "RetVal", "clib.array.libm2k.Double", "Description", "A list containing the previously setted sample rates");
+defineOutput(setSampleRateDefinition, "RetVal", "clib.array.libm2k.Double", "Description", "A list containing the previously set sample rates");
 validate(setSampleRateDefinition);
 
 %% C++ class method |setSampleRate| for C++ class |libm2k::analog::M2kAnalogOut| 
@@ -3264,7 +3264,7 @@
     "Description", "getUri Method of C++ class libm2k::context::Context." + newline + ...
     "Get the URI of the current context", ...
     "DetailedDescription", "This content is from the external library documentation."); % Modify help description values as needed.
-defineOutput(getUriDefinition, "RetVal", "string", "Description", "string containt the context URI (ex: ""usb:1.2.3"", ""ip:192.168.2.1"")");
+defineOutput(getUriDefinition, "RetVal", "string", "Description", "string containing the context URI (ex: ""usb:1.2.3"", ""ip:192.168.2.1"")");
 validate(getUriDefinition);
 
 %% C++ class method |getDMM| for C++ class |libm2k::context::Context| 
@@ -3302,7 +3302,7 @@
     "Description", "getAvailableContextAttributes Method of C++ class libm2k::context::Context." + newline + ...
     "Retrieve all the available context attributes", ...
     "DetailedDescription", "This content is from the external library documentation."); % Modify help description values as needed.
-defineOutput(getAvailableContextAttributesDefinition, "RetVal", "clib.array.libm2k.std.String", "Description", "A list of strings containg all the context attributes");
+defineOutput(getAvailableContextAttributesDefinition, "RetVal", "clib.array.libm2k.std.String", "Description", "A list of strings containing all the context attributes");
 validate(getAvailableContextAttributesDefinition);
 
 %% C++ class method |getContextAttributeValue| for C++ class |libm2k::context::Context| 

diff --git a/bindings/matlab/definelibm2k_win64.m b/bindings/matlab/definelibm2k_win64.m
@@ -2279,7 +2279,7 @@
     "Set the sample rate for both channels", ...
     "DetailedDescription", "This content is from the external library documentation."); % Modify help description values as needed.
 defineArgument(setSampleRateDefinition, "samplerates", "clib.array.libm2k.Double", "Description", "samplerates A list containing the sample rates of each channel");
-defineOutput(setSampleRateDefinition, "RetVal", "clib.array.libm2k.Double", "Description", "A list containing the previously setted sample rates");
+defineOutput(setSampleRateDefinition, "RetVal", "clib.array.libm2k.Double", "Description", "A list containing the previously set sample rates");
 validate(setSampleRateDefinition);
 
 %% C++ class method |setSampleRate| for C++ class |libm2k::analog::M2kAnalogOut| 
@@ -3267,7 +3267,7 @@
     "Description", "getUri Method of C++ class libm2k::context::Context." + newline + ...
     "Get the URI of the current context", ...
     "DetailedDescription", "This content is from the external library documentation."); % Modify help description values as needed.
-defineOutput(getUriDefinition, "RetVal", "string", "Description", "string containt the context URI (ex: ""usb:1.2.3"", ""ip:192.168.2.1"")");
+defineOutput(getUriDefinition, "RetVal", "string", "Description", "string containing the context URI (ex: ""usb:1.2.3"", ""ip:192.168.2.1"")");
 validate(getUriDefinition);
 
 %% C++ class method |getDMM| for C++ class |libm2k::context::Context| 
@@ -3305,7 +3305,7 @@
     "Description", "getAvailableContextAttributes Method of C++ class libm2k::context::Context." + newline + ...
     "Retrieve all the available context attributes", ...
     "DetailedDescription", "This content is from the external library documentation."); % Modify help description values as needed.
-defineOutput(getAvailableContextAttributesDefinition, "RetVal", "clib.array.libm2k.std.String", "Description", "A list of strings containg all the context attributes");
+defineOutput(getAvailableContextAttributesDefinition, "RetVal", "clib.array.libm2k.std.String", "Description", "A list of strings containing all the context attributes");
 validate(getAvailableContextAttributesDefinition);
 
 %% C++ class method |getContextAttributeValue| for C++ class |libm2k::context::Context| 

diff --git a/doc/Doxyfile_API.in b/doc/Doxyfile_API.in
@@ -150,7 +150,7 @@ INLINE_INHERITED_MEMB  = NO
 # shortest path that makes the file name unique will be used
 # The default value is: YES.
 
-FULL_PATH_NAMES        = YES
+FULL_PATH_NAMES        = NO
 
 # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
 # Stripping is only done if one of the specified strings matches the left-hand
@@ -171,7 +171,8 @@ STRIP_FROM_PATH        =
 # specify the list of include paths that are normally passed to the compiler
 # using the -I flag.
 
-STRIP_FROM_INC_PATH    =
+STRIP_FROM_INC_PATH    = @PROJECT_SOURCE_DIR@ \
+		         @PROJECT_BINARY_DIR@
 
 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
 # less readable) file names. This can be useful is your file systems doesn't
@@ -992,7 +993,7 @@ REFERENCES_RELATION    = NO
 # link to the documentation.
 # The default value is: YES.
 
-REFERENCES_LINK_SOURCE = YES
+REFERENCES_LINK_SOURCE = NO
 
 # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
 # source code will show a tooltip with additional information such as prototype,

diff --git a/include/libm2k/analog/dmm.hpp b/include/libm2k/analog/dmm.hpp
@@ -39,7 +39,7 @@ namespace analog {
  * @defgroup dmm DMM
  * @brief Contains the representation of the digital multimeter
  * @{
- * @class DMM
+ * @class DMM dmm.hpp libm2k/analog/dmm.hpp
  * @brief Controls the digital multimeter
  */
 class LIBM2K_API DMM {

diff --git a/include/libm2k/analog/enums.hpp b/include/libm2k/analog/enums.hpp
@@ -36,7 +36,7 @@ namespace analog {
 
 
 	/**
-	* @struct DMM_READING
+	* @struct DMM_READING enums.hpp libm2k/analog/enums.hpp
 	* @brief The structure of a DMM
 	*
 	*/

diff --git a/include/libm2k/analog/m2kanalogin.hpp b/include/libm2k/analog/m2kanalogin.hpp
@@ -40,7 +40,7 @@ namespace analog {
  * @defgroup analogin AnalogIn
  * @brief Contains the representation of the analogical input segment
  * @{
- * @class M2kAnalogIn
+ * @class M2kAnalogIn m2kanalogin.hpp libm2k/analog/m2kanalogin.hpp
  * @brief Controls the analogical input compound
  */
 class LIBM2K_API M2kAnalogIn

diff --git a/include/libm2k/analog/m2kanalogout.hpp b/include/libm2k/analog/m2kanalogout.hpp
@@ -46,7 +46,7 @@ namespace analog {
  * @defgroup analogout AnalogOut
  * @brief Contains the representation of the analogical output segment
  * @{
- * @class M2kAnalogOut
+ * @class M2kAnalogOut m2kanalogout.hpp libm2k/analog/m2kanalogout.hpp
  * @brief Controls the analogical output compound
  */
 class LIBM2K_API M2kAnalogOut
@@ -125,7 +125,7 @@ class LIBM2K_API M2kAnalogOut
 	* @brief Set the sample rate for both channels
 	*
 	* @param samplerates A list containing the sample rates of each channel
-	* @return A list containing the previously setted sample rates
+	* @return A list containing the previously set sample rates
 	*/
 	virtual std::vector<double> setSampleRate(std::vector<double> samplerates) = 0;
 

diff --git a/include/libm2k/analog/m2kpowersupply.hpp b/include/libm2k/analog/m2kpowersupply.hpp
@@ -36,7 +36,7 @@ namespace analog {
  * @defgroup powersupply PowerSupply
  * @brief Contains the representation of the power supply
  * @{
- * @class M2kPowerSupply
+ * @class M2kPowerSupply m2kpowersupply.hpp libm2k/analog/m2kpowersupply.hpp
  * @brief Controls the power supply
  */
 class LIBM2K_API M2kPowerSupply {

diff --git a/include/libm2k/context.hpp b/include/libm2k/context.hpp
@@ -46,7 +46,7 @@ class Generic;
 /** @defgroup context Context
  * @brief Contains the representation of a generic IIO context
  * @{
- * @class Context
+ * @class Context context.hpp libm2k/context.hpp
  * @brief Controls the IIO context
  */
 class LIBM2K_API Context {
@@ -71,7 +71,7 @@ class LIBM2K_API Context {
 
 	/**
 	 * @brief Get the URI of the current context
-	 * @return string containt the context URI (ex: "usb:1.2.3", "ip:192.168.2.1")
+	 * @return string containing the context URI (ex: "usb:1.2.3", "ip:192.168.2.1")
 	 */
 	virtual std::string getUri() = 0;
 
@@ -103,7 +103,7 @@ class LIBM2K_API Context {
 
 	/**
 	 * @brief Retrieve all the available context attributes
-	 * @return A list of strings containg all the context attributes
+	 * @return A list of strings containing all the context attributes
 	 */
 	virtual std::vector<std::string> getAvailableContextAttributes() = 0;
 

diff --git a/include/libm2k/digital/m2kdigital.hpp b/include/libm2k/digital/m2kdigital.hpp
@@ -38,7 +38,7 @@ namespace digital {
  * @defgroup digital Digital
  * @brief Contains the representation of the digital segment
  * @{
- * @class M2kDigital
+ * @class M2kDigital m2kdigital.hpp libm2k/digital/m2kdigital.hpp
  * @brief Controls the digital input and output segment
  */
 class LIBM2K_API M2kDigital

diff --git a/include/libm2k/enums.hpp b/include/libm2k/enums.hpp
@@ -51,7 +51,7 @@ namespace libm2k {
 
 
 	/**
-	* @struct CALIBRATION_PARAMETERS
+	* @struct CALIBRATION_PARAMETERS enums.hpp libm2k/enums.hpp
 	* @brief Calibration parameters of m2k
 	*/
 	struct CALIBRATION_PARAMETERS {
@@ -212,7 +212,7 @@ namespace libm2k {
 
 
 	/**
-	* @struct SETTINGS
+	* @struct SETTINGS enums.hpp libm2k/enums.hpp
 	* @brief Triggering system
 	*
 	*/
@@ -229,7 +229,7 @@ namespace libm2k {
 
 
 	/**
-	 * @struct CONTEXT_INFO
+	 * @struct CONTEXT_INFO enums.hpp libm2k/enums.hpp
 	 * @brief Additional information about the context
 	 */
 	struct CONTEXT_INFO {
@@ -255,7 +255,7 @@ namespace libm2k {
 	};
 
 	/**
-	 * @struct IIO_CONTEXT_VERSION
+	 * @struct IIO_CONTEXT_VERSION enums.hpp libm2k/enums.hpp
 	 * @brief The version of the backend
 	 */
 	struct IIO_CONTEXT_VERSION {

diff --git a/include/libm2k/m2k.hpp b/include/libm2k/m2k.hpp
@@ -48,7 +48,7 @@ namespace context {
 * @defgroup m2k M2k
 * @brief Contains the representation of the M2K
 * @{
-* @class M2k
+* @class M2k m2k.hpp libm2k/m2k.hpp
 * @brief Controls the ADALM2000
 */
 class LIBM2K_API M2k : public virtual Context

diff --git a/include/libm2k/m2khardwaretrigger.hpp b/include/libm2k/m2khardwaretrigger.hpp
@@ -35,7 +35,7 @@ namespace libm2k {
  * @defgroup m2ktrigger HardwareTrigger
  * @brief Contains the representation of the ADALM2000 trigger system
  * @{
- * @class M2kHardwareTrigger
+ * @class M2kHardwareTrigger m2khardwaretrigger.hpp libm2k/m2khardwaretrigger.hpp
  * @brief Controls the hardware trigger for ADALM2000
  */
 class LIBM2K_API M2kHardwareTrigger
-Original file line number
+Diff line change
@@ Expand Up / @@ -36,7 +36,7 @@ namespace analog { @@
     	/**
-    	* @struct DMM_READING
+    	* @struct DMM_READING enums.hpp libm2k/analog/enums.hpp
     	* @brief The structure of a DMM
     	*
     	*/
@@ Expand Down @@