Skip to content

Commit 0d9f312

Browse files
committed
Added some more Doxygen comments
1 parent 3b27272 commit 0d9f312

File tree

4 files changed

+42
-2
lines changed

4 files changed

+42
-2
lines changed

scopehal/SwitchMatrix.cpp

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,14 @@
2727
* *
2828
***********************************************************************************************************************/
2929

30+
/**
31+
@file
32+
@author Andrew D. Zonenberg
33+
@brief Implementation of SwitchMatrix
34+
35+
@ingroup core
36+
*/
37+
3038
#include "scopehal.h"
3139
#include "SwitchMatrix.h"
3240

scopehal/SwitchMatrix.h

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,11 +27,21 @@
2727
* *
2828
***********************************************************************************************************************/
2929

30+
/**
31+
@file
32+
@author Andrew D. Zonenberg
33+
@brief Declaration of SwitchMatrix
34+
35+
@ingroup core
36+
*/
37+
3038
#ifndef SwitchMatrix_h
3139
#define SwitchMatrix_h
3240

3341
/**
34-
@brief A generic power supply
42+
@brief Base class for switch matrixes
43+
44+
@ingroup core
3545
*/
3646
class SwitchMatrix : public virtual Instrument
3747
{

scopehal/TektronixHSIOscilloscope.cpp

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,14 @@
2727
* *
2828
***********************************************************************************************************************/
2929

30+
/**
31+
@file
32+
@author Andrew D. Zonenberg
33+
@brief Implementation of TektronixHSIOscilloscope
34+
35+
@ingroup scopedrivers
36+
*/
37+
3038
#include "scopehal.h"
3139
#include "TektronixHSIOscilloscope.h"
3240

@@ -35,6 +43,11 @@ using namespace std;
3543
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
3644
// Construction / destruction
3745

46+
/**
47+
@brief Initialize the driver
48+
49+
@param transport SCPITwinLanTransport pointing at the bridge server
50+
*/
3851
TektronixHSIOscilloscope::TektronixHSIOscilloscope(SCPITransport* transport)
3952
: SCPIDevice(transport)
4053
, SCPIInstrument(transport)

scopehal/TektronixHSIOscilloscope.h

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,13 +27,22 @@
2727
* *
2828
***********************************************************************************************************************/
2929

30+
/**
31+
@file
32+
@author Andrew D. Zonenberg
33+
@brief Declaration of TektronixHSIOscilloscope
34+
35+
@ingroup scopedrivers
36+
*/
37+
3038
#ifndef TektronixHSIOscilloscope_h
3139
#define TektronixHSIOscilloscope_h
3240

3341
#include <TektronixOscilloscope.h>
3442

3543
/**
36-
@brief TektronixHSIOscilloscope
44+
@brief Driver for the Tektronix HSI interface using an external bridge server (WIP)
45+
@ingroup scopedrivers
3746
*/
3847
class TektronixHSIOscilloscope : public TektronixOscilloscope
3948
{

0 commit comments

Comments
 (0)