From b51710ea6ce691acc39859eb0605bcb8e17ef644 Mon Sep 17 00:00:00 2001 From: Mark Rivers Date: Sun, 14 Sep 2014 17:11:10 -0500 Subject: [PATCH] Improved documentation for Doxygen --- andorApp/src/andorCCD.h | 10 +++++++++- andorApp/src/shamrock.cpp | 4 ++-- 2 files changed, 11 insertions(+), 3 deletions(-) diff --git a/andorApp/src/andorCCD.h b/andorApp/src/andorCCD.h index 12c1661..6d2ccdc 100755 --- a/andorApp/src/andorCCD.h +++ b/andorApp/src/andorCCD.h @@ -30,6 +30,10 @@ #define AndorPreAmpGainString "ANDOR_PREAMP_GAIN" #define AndorAdcSpeedString "ANDOR_ADC_SPEED" +/** + * Structure defining an ADC speed for the ADAndor driver. + * + */ typedef struct { int ADCIndex; int AmpIndex; @@ -40,6 +44,10 @@ typedef struct { int EnumValue; } AndorADCSpeed_t; +/** + * Structure defining a pre-amp gain for the ADAndor driver. + * + */ typedef struct { float Gain; char *EnumString; @@ -47,7 +55,7 @@ typedef struct { } AndorPreAmpGain_t; /** - * Driver class for Andor CCD. This inherits from ADDriver class in areaDetector. + * Driver for Andor CCD cameras using version 2 of their SDK; inherits from ADDriver class in ADCore. * */ class AndorCCD : public ADDriver { diff --git a/andorApp/src/shamrock.cpp b/andorApp/src/shamrock.cpp index 5ca8852..5bb3853 100755 --- a/andorApp/src/shamrock.cpp +++ b/andorApp/src/shamrock.cpp @@ -42,8 +42,8 @@ static const char *driverName = "shamrock"; // Maximum number of address. #define MAX_ADDR 4 -/** Main driver class inherited from asyn asynPortDriver class. - * One instance of this class will control one spectrography. +/** Driver for Andor Shamrock spectrographs. + * One instance of this class will control one spectrograph. */ class shamrock : public asynPortDriver {