~chris.gagnon/+junk/qtpim-coverage

« back to all changes in this revision

Viewing changes to src/versit/doc/src/versitclasses.qdoc

  • Committer: chris.gagnon
  • Date: 2013-12-10 23:09:37 UTC
  • Revision ID: chris.gagnon@canonical.com-20131210230937-2akf1ft1edcttk87
first post

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
/****************************************************************************
 
2
**
 
3
** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
 
4
** Contact: http://www.qt-project.org/legal
 
5
**
 
6
** This file is part of the documentation of the Qt PIM Module.
 
7
**
 
8
** $QT_BEGIN_LICENSE:FDL$
 
9
** Commercial License Usage
 
10
** Licensees holding valid commercial Qt licenses may use this file in
 
11
** accordance with the commercial license agreement provided with the
 
12
** Software or, alternatively, in accordance with the terms contained in
 
13
** a written agreement between you and Digia.  For licensing terms and
 
14
** conditions see http://qt.digia.com/licensing.  For further information
 
15
** use the contact form at http://qt.digia.com/contact-us.
 
16
**
 
17
** GNU Free Documentation License Usage
 
18
** Alternatively, this file may be used under the terms of the GNU Free
 
19
** Documentation License version 1.3 as published by the Free Software
 
20
** Foundation and appearing in the file included in the packaging of
 
21
** this file.  Please review the following information to ensure
 
22
** the GNU Free Documentation License version 1.3 requirements
 
23
** will be met: http://www.gnu.org/copyleft/fdl.html.
 
24
** $QT_END_LICENSE$
 
25
**
 
26
****************************************************************************/
 
27
 
 
28
/*!
 
29
    \module QtVersit
 
30
    \title Qt Versit C++ Classes
 
31
    \ingroup modules
 
32
    \brief The QtVersit module provides classes for personal information
 
33
    management.
 
34
 
 
35
        The \l{Qt Versit} API allows you to take standard VCard and VCal
 
36
    formatted test files and import your calendar or contact information into
 
37
    the \l{Qt Organizer} and \l{Qt Contact} APIs, resepectively. Alternatively
 
38
    the organizer and contacts information and export to VCal or VCard files
 
39
    which you can then import into other calendars and contacts, or easily share
 
40
    this with others through bluetooth or email, for example.
 
41
 
 
42
    To include the definitions of the module's classes, use the following
 
43
    directive:
 
44
 
 
45
    \snippet doc_src_qtversit.cpp versit include
 
46
    \snippet doc_src_qtversit.cpp versit organizer include
 
47
 
 
48
    To link against the module, add this line to your \l qmake \c .pro file:
 
49
 
 
50
    \snippet doc_src_qtversit.pro versit project modifications
 
51
 
 
52
*/