FCL/sf/mw/qtextensions: comparison qthighway/xqserviceutil/src/xqservicemetadata/xqservicemetadata.cpp

equal deleted inserted replaced

-:46686fb6258c
+:9d760f716ca8
 return in;
 }
 #endif
-/*
+/*!
 \class ServiceMetaData
+\brief Utility class offering support for parsing metadata
+service xml registry files.
 Utility class (used by service database) that offers support for
 parsing metadata service xml registry file during service registration. \n
 It uses QXMLStreamReader class for parsing. Supproted Operations are:
 - Parse the service and interfaces defined in XML file
 - name, version, capabilitiesList, description and filePath of service can be retrieved
 - each interface can be retrieved
 */
-/*
+/*!
-*  Class constructor
+Constructor
-*
+\param aXmlFilePath Path to the xml file that describes the service.
-* @param aXmlFilePath path to the xml file that describes the service.
+*/
-*/
 ServiceMetaData::ServiceMetaData(const QString &aXmlFilePath)
 {
 XQSERVICE_DEBUG_PRINT("ServiceMetaData::ServiceMetaData(1)");
 XQSERVICE_DEBUG_PRINT("aXmlFilePath: %s", qPrintable(aXmlFilePath));
 xmlDevice = new QFile(aXmlFilePath);
 ownsXmlDevice = true;
 latestError = 0;
 }
-/*
+/*!
-*  Class constructor
+Constructor
-*
+\param device QIODevice that contains the XML data that describes the service.
-* @param device QIODevice that contains the XML data that describes the service.
+*/
-*/
 ServiceMetaData::ServiceMetaData(QIODevice *device)
 {
 XQSERVICE_DEBUG_PRINT("ServiceMetaData::ServiceMetaData(2)");
 xmlDevice = device;
 ownsXmlDevice = false;
 latestError = 0;
 }
-/*
+/*!
-*  Class destructor
+Destructor
-*
+*/
-*/
 ServiceMetaData::~ServiceMetaData()
 {
 XQSERVICE_DEBUG_PRINT("ServiceMetaData::~ServiceMetaData");
 if (ownsXmlDevice)
 delete xmlDevice;
 }
-/*
+/*!
 Sets the device containing the XML data that describes the service to \a device.
-*/
+\param device Device containing XML data.
+*/
 void ServiceMetaData::setDevice(QIODevice *device)
 {
 XQSERVICE_DEBUG_PRINT("ServiceMetaData::setDevice");
 clearMetadata();
 xmlDevice = device;
 ownsXmlDevice = false;
 }
-/*
+/*!
-Returns the device containing the XML data that describes the service.
+Gets the device containing the XML data that describes the service.
+\return Device containing the XML data.
 */
 QIODevice *ServiceMetaData::device() const
 {
 XQSERVICE_DEBUG_PRINT("ServiceMetaData::device");
 return xmlDevice;
 }
-/*
+/*!
-*  Gets the service name
+Gets the service name.
-*
+\return Service name or default value (empty string) if it is not available.
-* @return service name or default value (empty string) if it is not available
+*/
-*/
 /*QString ServiceMetaData::name() const
 {
 return serviceName;
 }*/
-/*
+/*!
-*  Gets the path of the service implementation file
+Gets the path of the service implementation file.
-*
+\return Service implementation filepath.
-* @return service implementation filepath
+*/
-*/
 /*QString ServiceMetaData::location() const
 {
 return serviceLocation;
 }*/
-/*
+/*!
-*  Gets the service description
+Gets the service description.
-*
+\return Service description or default value (empty string) if it is not available.
-* @return service description or default value (empty string) if it is not available
+*/
-*/
 /*QString ServiceMetaData::description() const
 {
 return serviceDescription;
 }*/
-/*
+/*!
-Returns the metadata of the interace at \a index; otherwise
+Gets the list of interfaces.
-returns 0.
+\return List interfaces.
 */
 /*QList<XQServiceInterfaceDescriptor> ServiceMetaData::getInterfaces() const
 {
 return serviceInterfaces;
 } */
 /*!
 \internal
 Returns a streamable object containing the results of the parsing.
 */
 ServiceMetaDataResults ServiceMetaData::parseResults() const
 {
 XQSERVICE_DEBUG_PRINT("ServiceMetaData::parseResults");
 results.version = version;
 return results;
 }
-/*
+/*!
 Parses the file and extracts the service metadata \n
 Custom error codes: \n
 SFW_ERROR_UNABLE_TO_OPEN_FILE in case can not open the XML file \n
 SFW_ERROR_INVALID_XML_FILE in case service registry is not a valid XML file \n
 SFW_ERROR_NO_SERVICE in case XML file has no service tag\n
-@return true if the metadata was read properly, false if there is an error
+\return true if the metadata was read properly, false if there is an error.
 */
 bool ServiceMetaData::extractMetadata()
 {
 XQSERVICE_DEBUG_PRINT("ServiceMetaData::extractMetadata");
 latestError = 0;
 }
 XQSERVICE_DEBUG_PRINT("XML parseError: %d", parseError);
 return !parseError;
 }
-/*
+/*!
-Gets the latest parsing error \n
+Gets the latest parsing error.
-@return parsing error(negative value) or 0 in case there is none
+\return Parsing error(negative value) or 0 in case there is none.
 */
 int ServiceMetaData::getLatestError() const
 {
 XQSERVICE_DEBUG_PRINT("ServiceMetaData::getLatestError");
 XQSERVICE_DEBUG_PRINT("latestError: %d", latestError);
 return latestError;
 }
-/*
+/*!
 Parses and extracts the service from the current xml <service> node
-using the new format (Version 2) \n
+using the new format (Version 2).
 Schema:
 <!ELEMENT service ( name, filepath, description?, interface+ ) >
 <!ELEMENT description ( #CDATA ) >
 <!ELEMENT filepath ( #PCDATA ) >
 <!ELEMENT interface ( name, version, description?, capabilities?, customproperty* ) >
 /*!
 Parses and extracts the service from the current xml <service> node
 using the new format (Version 1) \n
 <!ELEMENT service ( description?, interface+ ) >
 <!ATTLIST service name #CDATA  #REQUIRED >
 <!ATTLIST service filepath #CDATA  #REQUIRED >
 <!ELEMENT description ( #CDATA ) >
 <!ELEMENT interface ( description? ) >
 <!ATTLIST interface name #CDATA  #REQUIRED >
 <!ATTLIST interface version #CDATA  #REQUIRED >
 <!ATTLIST interface capabilities #CDATA  >
 Custom error codes: \n
 SFW_ERROR_NO_SERVICE_NAME in case no service name in XML file \n
 SFW_ERROR_NO_INTERFACE_VERSION in case no interface version in XML file \n
 SFW_ERROR_PARSE_SERVICE in case can not parse service section in XML file \n
 SFW_ERROR_NO_SERVICE_FILEPATH in case no service file path in XML file \n
 SFW_ERROR_INVALID_XML_FILE in case XML file is not valid \n
-SFW_ERROR_NO_SERVICE_INTERFACE in case no interface defined for service in XML file \n
+SFW_ERROR_NO_SERVICE_INTERFACE in case no interface defined for service in XML file.
-@param aXMLReader xml stream reader
+\param aXMLReader xml stream reader .
-@return true if the metadata was read properly, false if there is an error
+\return true if the metadata was read properly, false if there is an error.
 */
 bool ServiceMetaData::processServiceElementPrevVersion(QXmlStreamReader &aXMLReader)
 {
 XQSERVICE_DEBUG_PRINT("parseError: %d", parseError);
 return !parseError;
 }
-/*
+/*!
-Parses and extracts the interface metadata from the current xml <interface> node \n
+Parses and extracts the interface metadata from the current xml <interface> node.
+\param aXMLReader xml stream reader .
+\return true if the metadata was read properly, false if there is an error.
 */
 bool ServiceMetaData::processInterfaceElement(QXmlStreamReader &aXMLReader)
 {
 XQSERVICE_DEBUG_PRINT("ServiceMetaData::processInterfaceElement");
 Q_ASSERT(aXMLReader.isStartElement() && aXMLReader.name() == INTERFACE_TAG);
 XQSERVICE_DEBUG_PRINT("processInterfaceElement parseError: %d", parseError);
 return !parseError;
 }
 /*!
-Parses and extracts the interface metadata from the current xml <interface> node \n
+Parses and extracts the interface metadata from the current xml <interface> node. \n
 Custome error codes: \n
 SFW_ERROR_NO_INTERFACE_NAME in case no interface name in XML file \n
 SFW_ERROR_PARSE_INTERFACE in case error parsing interface section \n
 SFW_ERROR_INVALID_XML_FILE in case XML file is not valid \n
-@param aXMLReader xml stream reader
+\param aXMLReader xml stream reader.
-@return true if the metadata was read properly, false if there is an error
+\return true if the metadata was read properly, false if there is an error.
 */
 bool ServiceMetaData::processInterfaceElementPrevVersion(QXmlStreamReader &aXMLReader)
 {
 XQSERVICE_DEBUG_PRINT("ServiceMetaData::processInterfaceElementPrevVersion");
 Q_ASSERT(aXMLReader.isStartElement() && aXMLReader.name() == INTERFACE_TAG);
 bool parseError = false;
 return !parseError;
 }
 /*!
-Gets the value of the attribute from the XML node \n
+Gets the value of the attribute from the XML node.
-@param aDomElement xml node
+\param aDomElement Xml node.
-@param aAttributeName attribute name
+\param aAttributeName Attribute name.
-@param aValue [out] attribute value
+\param aValue [out] attribute value.
-@return true if the value was read, false otherwise
+\return true if the value was read, false otherwise.
 */
 bool ServiceMetaData::getAttributeValue(const QXmlStreamReader &aXMLReader, const QString &aAttributeName, QString &aValue)
 {
 XQSERVICE_DEBUG_PRINT("ServiceMetaData::getAttributeValue");
 XQSERVICE_DEBUG_PRINT("aAttributeName: %s", qPrintable(aAttributeName));
 bool result = false;
 *major = list[1].toInt();
 *minor = list[2].toInt();
 }
 }
-/*
+/*!
-*  Clears the service metadata
+Clears the service metadata.
-*
+*/
-*/
 void ServiceMetaData::clearMetadata()
 {
 XQSERVICE_DEBUG_PRINT("ServiceMetaData::clearMetadata");
 serviceName.clear();
 serviceLocation.clear();

changeset 24	9d760f716ca8
parent 14	6fbed849b4f4