diff options
author | Leena Miettinen <riitta-leena.miettinen@theqtcompany.com> | 2015-01-28 12:21:25 +0100 |
---|---|---|
committer | Leena Miettinen <riitta-leena.miettinen@theqtcompany.com> | 2015-01-29 08:19:26 +0000 |
commit | 4d342d526ba17a92033a39e6631844863a588d5d (patch) | |
tree | 2d0e5a4995598f6446ba838827927509861094a6 /src/libs/installer/binaryformat.cpp | |
parent | 3561c20c401579e1507a9e20ff0c797ae7a64443 (diff) |
Doc: edited binaryformat docs
Fixed grammar, writing style, and QDoc command issues.
Change-Id: I93e79ad7294651071a2d3ab03cad657da1d23ba7
Reviewed-by: Niels Weber <niels.weber@theqtcompany.com>
Diffstat (limited to 'src/libs/installer/binaryformat.cpp')
-rw-r--r-- | src/libs/installer/binaryformat.cpp | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/src/libs/installer/binaryformat.cpp b/src/libs/installer/binaryformat.cpp index 015e21b2f..a5ff40e36 100644 --- a/src/libs/installer/binaryformat.cpp +++ b/src/libs/installer/binaryformat.cpp @@ -73,8 +73,8 @@ namespace QInstaller { \brief The Resource class is an interface for wrapping a file as read only device. Resource is an interface for reading inside a file, but is not supposed to write to the file it - wraps. The resource class is created by passing a path to an existing binary (such as a zipped - archive or a Qt resource file). + wraps. The \c Resource class is created by passing a path to an existing + binary (such as a zipped archive or a Qt resource file). The resource name can be set at any time using setName() or during construction. The segment supplied during construction represents the offset and size of the resource inside the file. @@ -156,7 +156,7 @@ void Resource::setName(const QByteArray &name) } /*! - A Resource will always be opened in QIODevice::ReadOnly mode. The function will return true + Opens a resource in QIODevice::ReadOnly mode. The function returns \c true if successful. */ bool Resource::open() @@ -340,7 +340,7 @@ QSharedPointer<Resource> ResourceCollection::resourceByName(const QByteArray &na \brief The ResourceCollectionManager class is an abstraction that groups together a number of resource collections. - The resources collections it groups can be written to and read from a QFileDevice. + The resource collections it groups can be written to and read from a QFileDevice. */ /*! |