Commit ace3ae92 authored by Alexander Stippich's avatar Alexander Stippich
Browse files

further cleanup and extended documentation

parent 5e8ba42b
...@@ -20,7 +20,9 @@ ...@@ -20,7 +20,9 @@
#include <QList> #include <QList>
#include <QImage> #include <QImage>
/** This namespace collects all methods and classes in LibKSane. */ /**
* This namespace collects all methods and classes in LibKSane.
*/
namespace KSaneIface namespace KSaneIface
{ {
...@@ -36,14 +38,19 @@ class KSANE_EXPORT KSaneCore : public QObject ...@@ -36,14 +38,19 @@ class KSANE_EXPORT KSaneCore : public QObject
friend class KSaneCorePrivate; friend class KSaneCorePrivate;
public: public:
/** @note There might come more enumerations in the future. */ /**
* Enum defining the message level of the returned scan status string.
* @note There might come more enumerations in the future.
*/
enum KSaneScanStatus { enum KSaneScanStatus {
NoError, // The scanning was finished successfully NoError, // The scanning has finished successfully
ErrorGeneral, // The error string should contain an error message. ErrorGeneral, // The error string should contain an error message.
Information // There is some information to the user. Information // There is some information to the user.
}; };
/** Enum determining whether the scanner opened correctly. */ /**
* Enum determining whether the scanner opened correctly.
*/
enum KSaneOpenStatus { enum KSaneOpenStatus {
OpeningSucceeded, // scanner opened successfully OpeningSucceeded, // scanner opened successfully
OpeningDenied, // access was denied, OpeningDenied, // access was denied,
...@@ -83,6 +90,9 @@ public: ...@@ -83,6 +90,9 @@ public:
WhiteLevelOption, WhiteLevelOption,
}; };
/*
* Struct describing scanner devices.
*/
struct DeviceInfo { struct DeviceInfo {
QString name; /* unique device name */ QString name; /* unique device name */
QString vendor; /* device vendor string */ QString vendor; /* device vendor string */
...@@ -96,7 +106,9 @@ public: ...@@ -96,7 +106,9 @@ public:
*/ */
KSaneCore(QObject *parent = nullptr); KSaneCore(QObject *parent = nullptr);
/** Standard destructor */ /**
* Standard destructor.
*/
~KSaneCore(); ~KSaneCore();
/** /**
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment