ISD::Camera

Search for usage in LXR

Public Types | Properties | Signals | Public Slots | Public Member Functions | Public Attributes | Protected Slots | List of all members
ISD::Camera Class Reference

#include <indicamera.h>

Inheritance diagram for ISD::Camera:
Inheritance graph
[legend]

Public Types

enum  BlobType {
  BLOB_IMAGE , BLOB_FITS , BLOB_XISF , BLOB_RAW ,
  BLOB_OTHER
}
 
enum  ErrorType { ERROR_CAPTURE , ERROR_SAVE , ERROR_LOAD , ERROR_VIEWER }
 
enum  TelescopeType { TELESCOPE_PRIMARY , TELESCOPE_GUIDE , TELESCOPE_UNKNOWN }
 
enum  UploadMode { UPLOAD_CLIENT , UPLOAD_LOCAL , UPLOAD_BOTH }
 
- Public Types inherited from QObject
typedef  QObjectList
 

Properties

bool StreamingEnabled
 
- Properties inherited from ISD::ConcreteDevice
bool connected
 
QString name
 
- Properties inherited from QObject
 objectName
 

Signals

void coolerToggled (bool enabled)
 
void error (ErrorType type)
 
void newBLOBManager (INDI::Property prop)
 
void newExposureValue (ISD::CameraChip *chip, double value, IPState state)
 
void newFPS (double instantFPS, double averageFPS)
 
void newGuideStarData (ISD::CameraChip *chip, double dx, double dy, double fit)
 
void newImage (const QSharedPointer< FITSData > &data, const QString &extension="")
 
void newRemoteFile (QString)
 
void newTemperatureValue (double value)
 
void newVideoFrame (const QSharedPointer< QImage > &frame)
 
void newView (const QSharedPointer< FITSView > &view)
 
void videoRecordToggled (bool enabled)
 
void videoStreamToggled (bool enabled)
 
- Signals inherited from ISD::ConcreteDevice
void Connected ()
 
void Disconnected ()
 
void propertyDefined (INDI::Property prop)
 
void propertyDeleted (INDI::Property prop)
 
void propertyUpdated (INDI::Property prop)
 
void ready ()
 

Public Slots

void setBLOBManager (const char *device, INDI::Property prop)
 
void StreamWindowHidden ()
 

Public Member Functions

 Camera (ISD::GenericDevice *parent)
 
bool canCool ()
 
bool configureRapidGuide (CameraChip *targetChip, bool autoLoop, bool sendImage=false, bool showMarker=false)
 
QString getCaptureFormat () const
 
const QStringList & getCaptureFormats () const
 
CameraChip * getChip (CameraChip::ChipType cType)
 
const QString & getEncodingFormat () const
 
const QStringList & getEncodingFormats () const
 
const QMap< QString, double > & getExposurePresets () const
 
const QPair< double, double > getExposurePresetsMinMax () const
 
bool getGain (double *value)
 
bool getGainMinMaxStep (double *min, double *max, double *step)
 
IPerm getGainPermission () const
 
bool getOffset (double *value)
 
bool getOffsetMinMaxStep (double *min, double *max, double *step)
 
IPerm getOffsetPermission () const
 
bool getSERNameDirectory (QString &filename, QString &directory)
 
bool getStreamExposure (double *duration)
 
TelescopeType getTelescopeType ()
 
bool getTemperature (double *value)
 
bool getTemperatureRegulation (double &ramp, double &threshold)
 
UploadMode getUploadMode ()
 
bool hasCooler ()
 
bool hasCoolerControl ()
 
bool hasGain ()
 
bool hasGuideHead ()
 
bool hasOffset ()
 
bool hasVideoStream ()
 
bool isBLOBEnabled ()
 
bool isCoolerOn ()
 
bool isFastExposureEnabled () const
 
bool isStreamingEnabled ()
 
bool processBLOB (INDI::Property prop) override
 
void processNumber (INDI::Property prop) override
 
void processSwitch (INDI::Property prop) override
 
void processText (INDI::Property prop) override
 
void registerProperty (INDI::Property prop) override
 
void removeProperty (INDI::Property prop) override
 
bool resetStreamingFrame ()
 
bool saveCurrentImage (QString &filename)
 
bool setBLOBEnabled (bool enable, const QString &prop=QString())
 
bool setCaptureFormat (const QString &format)
 
bool setCoolerControl (bool enable)
 
bool setEncodingFormat (const QString &value)
 
bool setFastCount (uint32_t count)
 
bool setFastExposureEnabled (bool enable)
 
bool setFITSHeaders (const QList< FITSData::Record > &values)
 
bool setGain (double value)
 
void setNextSequenceID (int count)
 
bool setOffset (double value)
 
bool setRapidGuide (CameraChip *targetChip, bool enable)
 
bool setScopeInfo (double focalLength, double aperture)
 
void setSeqPrefix (const QString &preFix)
 
bool setSERNameDirectory (const QString &filename, const QString &directory)
 
bool setStreamExposure (double duration)
 
bool setStreamingFrame (int x, int y, int w, int h)
 
bool setStreamLimits (uint16_t maxBufferSize, uint16_t maxPreviewFPS)
 
bool setTelescopeType (TelescopeType type)
 
bool setTemperature (double value)
 
bool setTemperatureRegulation (double ramp, double threshold)
 
bool setUploadMode (UploadMode mode)
 
bool setVideoStreamEnabled (bool enable)
 
bool startDurationRecording (double duration)
 
bool startFramesRecording (uint32_t frames)
 
bool startRecording ()
 
bool stopRecording ()
 
void updateUploadSettings (const QString &uploadDirectory, const QString &uploadFile)
 
- Public Member Functions inherited from ISD::ConcreteDevice
 ConcreteDevice (GenericDevice *parent)
 
void Connect ()
 
void Disconnect ()
 
GenericDevice * genericDevice () const
 
INDI::PropertyView< IBLOB > * getBLOB (const QString &name) const
 
const QString & getDeviceName () const
 
const QSharedPointer< DriverInfo > & getDriverInfo () const
 
uint32_t getDriverInterface ()
 
const QString & getDUBSObjectPath () const
 
INDI::PropertyView< ILight > * getLight (const QString &name) const
 
QString getMessage (int id) const
 
bool getMinMaxStep (const QString &propName, const QString &elementName, double *min, double *max, double *step) const
 
INDI::PropertyView< INumber > * getNumber (const QString &name) const
 
IPerm getPermission (const QString &propName) const
 
Properties getProperties () const
 
INDI::Property getProperty (const QString &name) const
 
IPState getState (const QString &propName) const
 
INDI::PropertyView< ISwitch > * getSwitch (const QString &name) const
 
INDI::PropertyView< IText > * getText (const QString &name) const
 
bool isConnected () const
 
bool isReady () const
 
virtual void processLight (INDI::Property) override
 
virtual void processMessage (int) override
 
void processProperties ()
 
void registeProperties ()
 
void sendNewProperty (INDI::Property prop)
 
bool setConfig (INDIConfig tConfig)
 
virtual void updateProperty (INDI::Property prop) override
 
- Public Member Functions inherited from ISD::GDInterface
 GDInterface (QObject *parent)
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
QBindable< QString > bindableObjectName ()
 
bool blockSignals (bool block)
 
const QObjectList & children () const const
 
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const
 
void deleteLater ()
 
void destroyed (QObject *obj)
 
bool disconnect (const char *signal, const QObject *receiver, const char *method) const const
 
bool disconnect (const QObject *receiver, const char *method) const const
 
void dumpObjectInfo () const const
 
void dumpObjectTree () const const
 
QList< QByteArray > dynamicPropertyNames () const const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
T findChild (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (Qt::FindChildOptions options) const const
 
bool inherits (const char *className) const const
 
void installEventFilter (QObject *filterObj)
 
bool isQuickItemType () const const
 
bool isWidgetType () const const
 
bool isWindowType () const const
 
void killTimer (int id)
 
virtual const QMetaObject * metaObject () const const
 
void moveToThread (QThread *targetThread)
 
QString objectName () const const
 
void objectNameChanged (const QString &objectName)
 
QObject * parent () const const
 
QVariant property (const char *name) const const
 
 Q_CLASSINFO (Name, Value)
 
 Q_EMIT Q_EMIT
 
 Q_ENUM (...)
 
 Q_ENUM_NS (...)
 
 Q_ENUMS (...)
 
 Q_FLAG (...)
 
 Q_FLAG_NS (...)
 
 Q_FLAGS (...)
 
 Q_GADGET Q_GADGET
 
 Q_GADGET_EXPORT (EXPORT_MACRO)
 
 Q_INTERFACES (...)
 
 Q_INVOKABLE Q_INVOKABLE
 
 Q_MOC_INCLUDE Q_MOC_INCLUDE
 
 Q_NAMESPACE Q_NAMESPACE
 
 Q_NAMESPACE_EXPORT (EXPORT_MACRO)
 
 Q_OBJECT Q_OBJECT
 
 Q_PROPERTY (...)
 
 Q_REVISION Q_REVISION
 
 Q_SET_OBJECT_NAME (Object)
 
 Q_SIGNAL Q_SIGNAL
 
 Q_SIGNALS Q_SIGNALS
 
 Q_SLOT Q_SLOT
 
 Q_SLOTS Q_SLOTS
 
T qobject_cast (const QObject *object)
 
T qobject_cast (QObject *object)
 
 QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
 
void removeEventFilter (QObject *obj)
 
void setObjectName (const QString &name)
 
void setObjectName (QAnyStringView name)
 
void setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool setProperty (const char *name, QVariant &&value)
 
bool signalsBlocked () const const
 
int startTimer (int interval, Qt::TimerType timerType)
 
int startTimer (std::chrono::milliseconds interval, Qt::TimerType timerType)
 
QThread * thread () const const
 

Public Attributes

enum ISD::Camera::BlobType BType
 

Protected Slots

void setWSBLOB (const QByteArray &message, const QString &extension)
 

Additional Inherited Members

- Static Public Member Functions inherited from QObject
QMetaObject::Connection connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
 
bool disconnect (const QMetaObject::Connection &connection)
 
bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
 
bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
 
bool disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
 
QString tr (const char *sourceText, const char *disambiguation, int n)
 
- Protected Member Functions inherited from QObject
virtual void childEvent (QChildEvent *event)
 
virtual void connectNotify (const QMetaMethod &signal)
 
virtual void customEvent (QEvent *event)
 
virtual void disconnectNotify (const QMetaMethod &signal)
 
bool isSignalConnected (const QMetaMethod &signal) const const
 
int receivers (const char *signal) const const
 
QObject * sender () const const
 
int senderSignalIndex () const const
 
virtual void timerEvent (QTimerEvent *event)
 
- Static Protected Member Functions inherited from ISD::ConcreteDevice
static uint8_t getID ()
 
- Protected Attributes inherited from ISD::ConcreteDevice
QString m_DBusObjectPath
 
QString m_Name
 
GenericDevice * m_Parent
 
QScopedPointer< QTimer > m_ReadyTimer
 
- Static Protected Attributes inherited from ISD::ConcreteDevice
static uint8_t m_ID = 1
 

Detailed Description

Camera class controls an INDI Camera device.

It can be used to issue and abort capture commands, receive and process BLOBs, and return information on the capabilities of the camera.

Author
Jasem Mutlaq

Definition at line 43 of file indicamera.h.

Member Enumeration Documentation

◆ BlobType

enum ISD::Camera::BlobType

Definition at line 53 of file indicamera.h.

◆ ErrorType

enum ISD::Camera::ErrorType
Enumerator
ERROR_SAVE 

INDI Camera error.

ERROR_LOAD 

Saving to disk error.

ERROR_VIEWER 

Loading image buffer error.

Loading in FITS Viewer Error

Definition at line 62 of file indicamera.h.

◆ TelescopeType

enum ISD::Camera::TelescopeType

Definition at line 61 of file indicamera.h.

◆ UploadMode

enum ISD::Camera::UploadMode

Definition at line 52 of file indicamera.h.

Property Documentation

◆ StreamingEnabled

bool ISD::Camera::StreamingEnabled

Definition at line 46 of file indicamera.h.

Constructor & Destructor Documentation

◆ Camera()

ISD::Camera::Camera ( ISD::GenericDevice * parent)
explicit

Definition at line 43 of file indicamera.cpp.

◆ ~Camera()

ISD::Camera::~Camera ( )
overridevirtual

Definition at line 54 of file indicamera.cpp.

Member Function Documentation

◆ canCool()

bool ISD::Camera::canCool ( )
inline

Definition at line 83 of file indicamera.h.

◆ configureRapidGuide()

bool ISD::Camera::configureRapidGuide ( CameraChip * targetChip,
bool autoLoop,
bool sendImage = false,
bool showMarker = false )

Definition at line 809 of file indicamera.cpp.

◆ getCaptureFormat()

QString ISD::Camera::getCaptureFormat ( ) const

Definition at line 1554 of file indicamera.cpp.

◆ getCaptureFormats()

const QStringList & ISD::Camera::getCaptureFormats ( ) const
inline

Definition at line 164 of file indicamera.h.

◆ getChip()

CameraChip * ISD::Camera::getChip ( CameraChip::ChipType cType)

Definition at line 764 of file indicamera.cpp.

◆ getEncodingFormat()

const QString & ISD::Camera::getEncodingFormat ( ) const
inline

Definition at line 153 of file indicamera.h.

◆ getEncodingFormats()

const QStringList & ISD::Camera::getEncodingFormats ( ) const
inline

Definition at line 158 of file indicamera.h.

◆ getExposurePresets()

const QMap< QString, double > & ISD::Camera::getExposurePresets ( ) const
inline

Definition at line 211 of file indicamera.h.

◆ getExposurePresetsMinMax()

const QPair< double, double > ISD::Camera::getExposurePresetsMinMax ( ) const
inline

Definition at line 215 of file indicamera.h.

◆ getGain()

bool ISD::Camera::getGain ( double * value)

Definition at line 1341 of file indicamera.cpp.

◆ getGainMinMaxStep()

bool ISD::Camera::getGainMinMaxStep ( double * min,
double * max,
double * step )

Definition at line 1351 of file indicamera.cpp.

◆ getGainPermission()

IPerm ISD::Camera::getGainPermission ( ) const
inline

Definition at line 123 of file indicamera.h.

◆ getOffset()

bool ISD::Camera::getOffset ( double * value)

Definition at line 1373 of file indicamera.cpp.

◆ getOffsetMinMaxStep()

bool ISD::Camera::getOffsetMinMaxStep ( double * min,
double * max,
double * step )

Definition at line 1383 of file indicamera.cpp.

◆ getOffsetPermission()

IPerm ISD::Camera::getOffsetPermission ( ) const
inline

Definition at line 136 of file indicamera.h.

◆ getSERNameDirectory()

bool ISD::Camera::getSERNameDirectory ( QString & filename,
QString & directory )

Definition at line 1177 of file indicamera.cpp.

◆ getStreamExposure()

bool ISD::Camera::getStreamExposure ( double * duration)

Definition at line 1465 of file indicamera.cpp.

◆ getTelescopeType()

TelescopeType ISD::Camera::getTelescopeType ( )
inline

Definition at line 193 of file indicamera.h.

◆ getTemperature()

bool ISD::Camera::getTemperature ( double * value)

Definition at line 947 of file indicamera.cpp.

◆ getTemperatureRegulation()

bool ISD::Camera::getTemperatureRegulation ( double & ramp,
double & threshold )

Definition at line 1487 of file indicamera.cpp.

◆ getUploadMode()

Camera::UploadMode ISD::Camera::getUploadMode ( )

Definition at line 869 of file indicamera.cpp.

◆ hasCooler()

bool ISD::Camera::hasCooler ( )

Definition at line 731 of file indicamera.cpp.

◆ hasCoolerControl()

bool ISD::Camera::hasCoolerControl ( )

Definition at line 736 of file indicamera.cpp.

◆ hasGain()

bool ISD::Camera::hasGain ( )
inline

Definition at line 118 of file indicamera.h.

◆ hasGuideHead()

bool ISD::Camera::hasGuideHead ( )

Definition at line 726 of file indicamera.cpp.

◆ hasOffset()

bool ISD::Camera::hasOffset ( )
inline

Definition at line 131 of file indicamera.h.

◆ hasVideoStream()

bool ISD::Camera::hasVideoStream ( )
inline

Definition at line 92 of file indicamera.h.

◆ isBLOBEnabled()

bool ISD::Camera::isBLOBEnabled ( )

Definition at line 1395 of file indicamera.cpp.

◆ isCoolerOn()

bool ISD::Camera::isCoolerOn ( )

Definition at line 1477 of file indicamera.cpp.

◆ isFastExposureEnabled()

bool ISD::Camera::isFastExposureEnabled ( ) const
inline

Definition at line 205 of file indicamera.h.

◆ isStreamingEnabled()

bool ISD::Camera::isStreamingEnabled ( )

Definition at line 1148 of file indicamera.cpp.

◆ processBLOB()

bool ISD::Camera::processBLOB ( INDI::Property prop)
overridevirtual

Reimplemented from ISD::ConcreteDevice.

Definition at line 599 of file indicamera.cpp.

◆ processNumber()

void ISD::Camera::processNumber ( INDI::Property prop)
overridevirtual

Reimplemented from ISD::ConcreteDevice.

Definition at line 276 of file indicamera.cpp.

◆ processSwitch()

void ISD::Camera::processSwitch ( INDI::Property prop)
overridevirtual

Reimplemented from ISD::ConcreteDevice.

Definition at line 353 of file indicamera.cpp.

◆ processText()

void ISD::Camera::processText ( INDI::Property prop)
overridevirtual

Reimplemented from ISD::ConcreteDevice.

Definition at line 482 of file indicamera.cpp.

◆ registerProperty()

void ISD::Camera::registerProperty ( INDI::Property prop)
overridevirtual

Reimplemented from ISD::ConcreteDevice.

Definition at line 73 of file indicamera.cpp.

◆ removeProperty()

void ISD::Camera::removeProperty ( INDI::Property prop)
overridevirtual

Reimplemented from ISD::ConcreteDevice.

Definition at line 268 of file indicamera.cpp.

◆ resetStreamingFrame()

bool ISD::Camera::resetStreamingFrame ( )

Definition at line 1058 of file indicamera.cpp.

◆ saveCurrentImage()

bool ISD::Camera::saveCurrentImage ( QString & filename)

saveCurrentImage save the image that is currently in the image data buffer

Returns
true if saving succeeded

Definition at line 576 of file indicamera.cpp.

◆ setBLOBEnabled()

bool ISD::Camera::setBLOBEnabled ( bool enable,
const QString & prop = QString() )

Definition at line 1400 of file indicamera.cpp.

◆ setBLOBManager

void ISD::Camera::setBLOBManager ( const char * device,
INDI::Property prop )
slot

Definition at line 64 of file indicamera.cpp.

◆ setCaptureFormat()

bool ISD::Camera::setCaptureFormat ( const QString & format)

Definition at line 1424 of file indicamera.cpp.

◆ setCoolerControl()

bool ISD::Camera::setCoolerControl ( bool enable)

Definition at line 741 of file indicamera.cpp.

◆ setEncodingFormat()

bool ISD::Camera::setEncodingFormat ( const QString & value)

Definition at line 981 of file indicamera.cpp.

◆ setFastCount()

bool ISD::Camera::setFastCount ( uint32_t count)

Definition at line 1437 of file indicamera.cpp.

◆ setFastExposureEnabled()

bool ISD::Camera::setFastExposureEnabled ( bool enable)

Definition at line 1407 of file indicamera.cpp.

◆ setFITSHeaders()

bool ISD::Camera::setFITSHeaders ( const QList< FITSData::Record > & values)

Definition at line 1311 of file indicamera.cpp.

◆ setGain()

bool ISD::Camera::setGain ( double value)

Definition at line 1331 of file indicamera.cpp.

◆ setNextSequenceID()

void ISD::Camera::setNextSequenceID ( int count)
inline

Definition at line 112 of file indicamera.h.

◆ setOffset()

bool ISD::Camera::setOffset ( double value)

Definition at line 1363 of file indicamera.cpp.

◆ setRapidGuide()

bool ISD::Camera::setRapidGuide ( CameraChip * targetChip,
bool enable )

Definition at line 778 of file indicamera.cpp.

◆ setScopeInfo()

bool ISD::Camera::setScopeInfo ( double focalLength,
double aperture )

Definition at line 1510 of file indicamera.cpp.

◆ setSeqPrefix()

void ISD::Camera::setSeqPrefix ( const QString & preFix)
inline

Definition at line 108 of file indicamera.h.

◆ setSERNameDirectory()

bool ISD::Camera::setSERNameDirectory ( const QString & filename,
const QString & directory )

Definition at line 1156 of file indicamera.cpp.

◆ setStreamExposure()

bool ISD::Camera::setStreamExposure ( double duration)

Definition at line 1451 of file indicamera.cpp.

◆ setStreamingFrame()

bool ISD::Camera::setStreamingFrame ( int x,
int y,
int w,
int h )

Definition at line 1115 of file indicamera.cpp.

◆ setStreamLimits()

bool ISD::Camera::setStreamLimits ( uint16_t maxBufferSize,
uint16_t maxPreviewFPS )

Definition at line 1090 of file indicamera.cpp.

◆ setTelescopeType()

bool ISD::Camera::setTelescopeType ( TelescopeType type)

Definition at line 1006 of file indicamera.cpp.

◆ setTemperature()

bool ISD::Camera::setTemperature ( double value)

Definition at line 962 of file indicamera.cpp.

◆ setTemperatureRegulation()

bool ISD::Camera::setTemperatureRegulation ( double ramp,
double threshold )

Definition at line 1498 of file indicamera.cpp.

◆ setUploadMode()

bool ISD::Camera::setUploadMode ( UploadMode mode)

Definition at line 900 of file indicamera.cpp.

◆ setVideoStreamEnabled()

bool ISD::Camera::setVideoStreamEnabled ( bool enable)

Definition at line 1036 of file indicamera.cpp.

◆ setWSBLOB

void ISD::Camera::setWSBLOB ( const QByteArray & message,
const QString & extension )
protectedslot

Definition at line 493 of file indicamera.cpp.

◆ startDurationRecording()

bool ISD::Camera::startDurationRecording ( double duration)

Definition at line 1219 of file indicamera.cpp.

◆ startFramesRecording()

bool ISD::Camera::startFramesRecording ( uint32_t frames)

Definition at line 1255 of file indicamera.cpp.

◆ startRecording()

bool ISD::Camera::startRecording ( )

Definition at line 1196 of file indicamera.cpp.

◆ stopRecording()

bool ISD::Camera::stopRecording ( )

Definition at line 1287 of file indicamera.cpp.

◆ StreamWindowHidden

void ISD::Camera::StreamWindowHidden ( )
slot

Definition at line 686 of file indicamera.cpp.

◆ updateUploadSettings()

void ISD::Camera::updateUploadSettings ( const QString & uploadDirectory,
const QString & uploadFile )

Definition at line 844 of file indicamera.cpp.

The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Fri Oct 4 2024 12:01:06 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.