Partial Doxygen coverage of AgilentOscilloscope, not complete yet but better than nothing

Author: azonenberg

scopehal/AgilentOscilloscope.cpp

@@ -1,8 +1,8 @@
 /***********************************************************************************************************************
 *                                                                                                                      *
-* libscopehal v0.1                                                                                                     *
+* libscopehal                                                                                                          *
 *                                                                                                                      *
-* Copyright (c) 2012-2023 Andrew D. Zonenberg and contributors                                                         *
+* Copyright (c) 2012-2024 Andrew D. Zonenberg and contributors                                                         *
 * All rights reserved.                                                                                                 *
 *                                                                                                                      *
 * Redistribution and use in source and binary forms, with or without modification, are permitted provided that the     *
@@ -27,6 +27,12 @@
 *                                                                                                                      *
 ***********************************************************************************************************************/
 
+/**
+	@file
+	@brief Implementation of AgilentOscilloscope
+	@ingroup scopedrivers
+ */
+
 #include "scopehal.h"
 #include "AgilentOscilloscope.h"
 #include "EdgeTrigger.h"
@@ -40,6 +46,11 @@ using namespace std;
 ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
 // Construction / destruction
 
+/**
+	@brief Connect to an oscilloscope
+
+	@param transport	SCPITransport connected to the scope
+ */
 AgilentOscilloscope::AgilentOscilloscope(SCPITransport* transport)
 	: SCPIDevice(transport)
 	, SCPIInstrument(transport)

scopehal/AgilentOscilloscope.h

@@ -27,13 +27,23 @@
 *                                                                                                                      *
 ***********************************************************************************************************************/
 
+/**
+	@file
+	@brief Declaration of AgilentOscilloscope
+	@ingroup scopedrivers
+ */
+
 #ifndef AgilentOscilloscope_h
 #define AgilentOscilloscope_h
 
 #include "EdgeTrigger.h"
 #include "PulseWidthTrigger.h"
 #include "NthEdgeBurstTrigger.h"
 
+/**
+	@brief Driver for Agilent (and some Keysight) oscilloscopes
+	@ingroup scopedrivers
+ */
 class AgilentOscilloscope : public virtual SCPIOscilloscope
 {
 public:
@@ -96,17 +106,30 @@ class AgilentOscilloscope : public virtual SCPIOscilloscope
 	virtual bool SetInterleaving(bool combine) override;
 
 protected:
+
+	///@brief External trigger
 	OscilloscopeChannel* m_extTrigChannel;
 
-	//hardware analog channel count, independent of LA option etc
+	///@brief Hardware analog channel count, independent of LA option etc
 	unsigned int m_analogChannelCount;
+
+	///@brief Number of digital channels supported
 	unsigned int m_digitalChannelCount;
+
+	///@brief Index of the first digital channel (if any)
 	unsigned int m_digitalChannelBase;
 
-	enum ProbeType {
+	///@brief Type of probe connected to a channel
+	enum ProbeType
+	{
+		///@brief No probe, or no ID ring present
 		None,
+
+		///@brief Passive probe with ID resistor for detecting attenuation
 		AutoProbe,
-		SmartProbe,
+
+		///@brief Active probe
+		SmartProbe
 	};
 
 	//config cache