diff options
| author | Andre Hartmann <aha_1980@gmx.de> | 2016-07-14 20:42:06 +0200 |
|---|---|---|
| committer | André Hartmann <aha_1980@gmx.de> | 2016-07-15 12:19:36 +0000 |
| commit | 548562fc40913a6f4788245830e964eaf7dcb88e (patch) | |
| tree | 7d8d9fb8decf25b5f8f94139b801a1da6e5aa672 /src/serialbus/qcanbusfactory.cpp | |
| parent | 9d44d7a383e87074c712f51f4efa85e9cca83310 (diff) | |
CAN: Documentation fixes
Change-Id: I33da0e7d04541073d8d8307048c08715a228b3cc
Reviewed-by: Alex Blasche <alexander.blasche@theqtcompany.com>
Reviewed-by: Denis Shienkov <denis.shienkov@gmail.com>
Diffstat (limited to 'src/serialbus/qcanbusfactory.cpp')
| -rw-r--r-- | src/serialbus/qcanbusfactory.cpp | 14 |
1 files changed, 9 insertions, 5 deletions
diff --git a/src/serialbus/qcanbusfactory.cpp b/src/serialbus/qcanbusfactory.cpp index 968e16d..3775484 100644 --- a/src/serialbus/qcanbusfactory.cpp +++ b/src/serialbus/qcanbusfactory.cpp @@ -50,13 +50,17 @@ QT_BEGIN_NAMESPACE */ /*! - \fn QCanBusDevice *QCanBusFactory::createDevice(const QString &interfaceName) const + \fn QCanBusDevice *QCanBusFactory::createDevice(const QString &interfaceName, + QString *errorMessage) const - Creates a new QCanBusDevice. - \a interfaceName is the network/CAN interface name. The caller must take - ownership of the returned pointer. + Creates a new QCanBusDevice. The caller must take ownership of the returned pointer. - If the factory cannot create a backend, it returns 0. + \a interfaceName is the network/CAN interface name. + \a errorMessage contains an error description in case of failure. + + If the factory cannot create a backend, it returns \c nullptr. + + \since 5.8 */ /*! |