From b60b6e197062d36c02cae52318ebca9cf20b0a69 Mon Sep 17 00:00:00 2001
From: Kavindra Devi Palaraja <kavindra.palaraja@nokia.com>
Date: Mon, 20 Apr 2009 14:17:24 +0200
Subject: [PATCH] Fixes: - Doc more on the tutorial.
---
doc/addressbook-sdk.qdoc | 38 ++++++++-----------
.../addressbook-sdk/part1/addressbook.cpp | 2 +
.../addressbook-sdk/part1/addressbook.h | 2 +
doc/examples/addressbook-sdk/part1/main.cpp | 2 +
4 files changed, 22 insertions(+), 22 deletions(-)
diff --git a/doc/addressbook-sdk.qdoc b/doc/addressbook-sdk.qdoc
index 60b51a59cd..66ffe27ec3 100644
--- a/doc/addressbook-sdk.qdoc
+++ b/doc/addressbook-sdk.qdoc
@@ -180,12 +180,12 @@
address book is needed.
- \section1 Defining the AddressBook Class
+ \section1 The AddressBook Class
The \l{examples/addressbook-sdk/part1/addressbook.h}{\c addressbook.h} file
is used to define the \c AddressBook class.
- We start by looking at what is already provided for us by Qt Creator. The
+ Let's take a look at what is already provided for us by Qt Creator. The
\c AddressBook class has been defined as a QWidget subclass with a
constructor and destructor.The Q_OBJECT macro is used to indicate that this
class uses internationalization and Qt's signals and slots features.
@@ -195,31 +195,25 @@
\snippet examples/addressbook-sdk/part1/addressbook.h class definition
- Qt Creator's project wizard provides us with the \c Ui object as a way to
- access the widgets on our form.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+ Qt Creator's \gui{Project Wizard} provides us with the \c Ui object as a
+ way to access the widgets on our form.
+ The \l{examples/addressbook-sdk/part1/addressbook.cpp}{\c addressbook.cpp}
+ file is used to implement the \c AddressBook class. The constructor sets up
+ the \c ui file; the destructor deletes it.
+ \snippet examples/addressbook-sdk/part1/addressbook.cpp class implementation
+ \section1 The \c{main()} Function
+ The \l{examples/addressbook-sdk/part1/main.cpp}{\c main.cpp} file contains
+ the \c{main()} function It is generated by the \gui{Project Wizard}.
+ Within this function, a QApplication object, \c a, is instantiated.
+ QApplication is responsible for various application-wide resources, such as
+ the default font and cursor, and for running an event loop. Hence, there is
+ always one QApplication objet in every GUI application using Qt.
+ \snippet examples/addressbook-sdk/part1/main.cpp main function
*/
diff --git a/doc/examples/addressbook-sdk/part1/addressbook.cpp b/doc/examples/addressbook-sdk/part1/addressbook.cpp
index 2779168a3f..38e9404f31 100644
--- a/doc/examples/addressbook-sdk/part1/addressbook.cpp
+++ b/doc/examples/addressbook-sdk/part1/addressbook.cpp
@@ -1,3 +1,4 @@
+//! [class implementation]
#include "addressbook.h"
#include "ui_addressbook.h"
@@ -11,3 +12,4 @@ AddressBook::~AddressBook()
{
delete ui;
}
+//! [class implementation]
diff --git a/doc/examples/addressbook-sdk/part1/addressbook.h b/doc/examples/addressbook-sdk/part1/addressbook.h
index 684dd102c4..c5937d435b 100644
--- a/doc/examples/addressbook-sdk/part1/addressbook.h
+++ b/doc/examples/addressbook-sdk/part1/addressbook.h
@@ -1,3 +1,4 @@
+//! [class definition]
#ifndef ADDRESSBOOK_H
#define ADDRESSBOOK_H
@@ -21,3 +22,4 @@ private:
};
#endif // ADDRESSBOOK_H
+//! [class definition]
diff --git a/doc/examples/addressbook-sdk/part1/main.cpp b/doc/examples/addressbook-sdk/part1/main.cpp
index 437a1c8352..3378b4adce 100644
--- a/doc/examples/addressbook-sdk/part1/main.cpp
+++ b/doc/examples/addressbook-sdk/part1/main.cpp
@@ -1,3 +1,4 @@
+//! [main function]
#include <QtGui/QApplication>
#include "addressbook.h"
@@ -8,3 +9,4 @@ int main(int argc, char *argv[])
w.show();
return a.exec();
}
+//! [main function]
--
GitLab