TektronixOscilloscope: finished initial doxygen pass

Author: azonenberg

scopehal/TektronixOscilloscope.cpp

@@ -2687,7 +2687,11 @@ void TektronixOscilloscope::PullTrigger()
 }
 
 /**
-	@brief Parses a trigger level message
+	@brief Determine the current trigger level
+
+	@param chan	The channel selected as the trigger source
+
+	@return	The current trigger level, in volts
  */
 float TektronixOscilloscope::ReadTriggerLevelMSO56(OscilloscopeChannel* chan)
 {
@@ -2983,7 +2987,7 @@ void TektronixOscilloscope::PullRuntTrigger()
 }
 
 /**
-	@brief Reads settings for a runt trigger from the instrument
+	@brief Reads settings for a slew rate trigger from the instrument
  */
 void TektronixOscilloscope::PullSlewRateTrigger()
 {
@@ -3144,6 +3148,11 @@ void TektronixOscilloscope::PushTrigger()
 		LogWarning("Unknown trigger type (not an edge)\n");
 }
 
+/**
+	@brief Push the current trigger voltage level to hardware
+
+	@param trig	The trigger to push
+ */
 void TektronixOscilloscope::SetTriggerLevelMSO56(Trigger* trig)
 {
 	auto chan = trig->GetInput(0).m_channel;
@@ -3159,6 +3168,8 @@ void TektronixOscilloscope::SetTriggerLevelMSO56(Trigger* trig)
 
 /**
 	@brief Pushes settings for an edge trigger to the instrument
+
+	@param trig	The trigger to push
  */
 void TektronixOscilloscope::PushEdgeTrigger(EdgeTrigger* trig)
 {
@@ -3202,6 +3213,11 @@ void TektronixOscilloscope::PushEdgeTrigger(EdgeTrigger* trig)
 	}
 }
 
+/**
+	@brief Pushes settings for a pulse width trigger to the instrument
+
+	@param trig	The trigger to push
+ */
 void TektronixOscilloscope::PushPulseWidthTrigger(PulseWidthTrigger* trig)
 {
 	switch(m_family)
@@ -3263,6 +3279,8 @@ void TektronixOscilloscope::PushPulseWidthTrigger(PulseWidthTrigger* trig)
 
 /**
 	@brief Pushes settings for a dropout trigger to the instrument
+
+	@param trig	The trigger to push
  */
 void TektronixOscilloscope::PushDropoutTrigger(DropoutTrigger* trig)
 {
@@ -3306,6 +3324,8 @@ void TektronixOscilloscope::PushDropoutTrigger(DropoutTrigger* trig)
 
 /**
 	@brief Pushes settings for a runt trigger to the instrument
+
+	@param trig	The trigger to push
  */
 void TektronixOscilloscope::PushRuntTrigger(RuntTrigger* trig)
 {
@@ -3377,7 +3397,9 @@ void TektronixOscilloscope::PushRuntTrigger(RuntTrigger* trig)
 }
 
 /**
-	@brief Pushes settings for a runt trigger to the instrument
+	@brief Pushes settings for a slew rate trigger to the instrument
+
+	@param trig	The trigger to push
  */
 void TektronixOscilloscope::PushSlewRateTrigger(SlewRateTrigger* trig)
 {
@@ -3445,7 +3467,9 @@ void TektronixOscilloscope::PushSlewRateTrigger(SlewRateTrigger* trig)
 }
 
 /**
-	@brief Pushes settings for a runt trigger to the instrument
+	@brief Pushes settings for a window trigger to the instrument
+
+	@param trig	The trigger to push
  */
 void TektronixOscilloscope::PushWindowTrigger(WindowTrigger* trig)
 {

scopehal/TektronixOscilloscope.h

@@ -355,10 +355,16 @@ class TektronixOscilloscope
 	//The lane number for each flex channel
 	std::map<OscilloscopeChannel*, size_t> m_flexChannelLanes;
 
+	///@brief Starting index for digital channels
 	size_t m_digitalChannelBase;
+
+	///@brief Starting index for spectrum channels
 	size_t m_spectrumChannelBase;
 
+	///@brief True if trigger is armed, false if idle
 	bool m_triggerArmed;
+
+	///@brief True if trigger is single or forced, false if continuous
 	bool m_triggerOneShot;
 
 	void PullEdgeTrigger();
@@ -377,10 +383,23 @@ class TektronixOscilloscope
 	float ReadTriggerLevelMSO56(OscilloscopeChannel* chan);
 	void SetTriggerLevelMSO56(Trigger* trig);
 
-	//Helpers for figuring out type of a channel by the index
+	/**
+		@brief Check if a channel is analog given the index
+
+		@param index	Channel number
+
+		@return	True if analog, false if spectrum or digital
+	 */
 	bool IsAnalog(size_t index)
 	{ return index < m_analogChannelCount; }
 
+	/**
+		@brief Check if a channel is digital given the index
+
+		@param index	Channel number
+
+		@return	True if digital, false if spectrum or analog
+	 */
 	bool IsDigital(size_t index)
 	{
 		if(index < m_digitalChannelBase)
@@ -390,6 +409,13 @@ class TektronixOscilloscope
 		return true;
 	}
 
+	/**
+		@brief Check if a channel is spectrum given the index
+
+		@param index	Channel number
+
+		@return	True if spectrum, false if analog or digital
+	 */
 	bool IsSpectrum(size_t index)
 	{
 		if(index < m_spectrumChannelBase)
@@ -399,17 +425,23 @@ class TektronixOscilloscope
 		return true;
 	}
 
-	///Maximum bandwidth we support, in MHz
+	///@brief Maximum bandwidth we support, in MHz
 	unsigned int m_maxBandwidth;
 
+	///@brief Type of scope we're connected to
 	enum Family
 	{
+		///@brief MSO5 series
 		FAMILY_MSO5,
+
+		///@brief MSO6 series
 		FAMILY_MSO6,
+
+		///@brief Other or unknown
 		FAMILY_UNKNOWN
 	} m_family;
 
-	//Installed software options
+	///@brief True if we have the DVM option installed
 	bool m_hasDVM;
 
 	/**
@@ -430,14 +462,28 @@ class TektronixOscilloscope
 	bool IsEnableStateDirty(size_t chan);
 	void FlushChannelEnableStates();
 
-	//Function generator state
+	///@brief True if we have the AFG option installed
 	bool m_hasAFG;
+
+	///@brief True if the AFG is currently outputting a waveform
 	bool m_afgEnabled;
+
+	///@brief Amplitude of the AFG output, in volts
 	float m_afgAmplitude;
+
+	///@brief DC offset of the AFG output, in volts
 	float m_afgOffset;
+
+	///@brief Frequency of the AFG output, in Hz
 	float m_afgFrequency;
+
+	///@brief Duty cycle of the AFG output (0-1)
 	float m_afgDutyCycle;
+
+	///@brief Waveform the AFG is outputting
 	FunctionGenerator::WaveShape m_afgShape;
+
+	///@brief Impedance selected for the AFG output
 	FunctionGenerator::OutputImpedance m_afgImpedance;
 
 public: