Skip to content

Commit f06eeb8

Browse files
committed
EyeWaveform: added some doxygen comments
1 parent 3bd615e commit f06eeb8

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

scopehal/EyeWaveform.h

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,13 +31,20 @@
3131
@file
3232
@author Andrew D. Zonenberg
3333
@brief Declaration of EyeWaveform
34+
@ingroup datamodel
3435
*/
3536

3637
#ifndef EyeWaveform_h
3738
#define EyeWaveform_h
3839

3940
#include "../scopehal/DensityFunctionWaveform.h"
4041

42+
/**
43+
@brief An eye-pattern waveform
44+
@ingroup datamodel
45+
46+
May be generated by a filter or directly measured by a BERT, sampling oscilloscope, etc.
47+
*/
4148
class EyeWaveform : public DensityFunctionWaveform
4249
{
4350
public:

0 commit comments

Comments
 (0)