← Back to branch summary

~ubuntu-branches/ubuntu/lucid/kmess/lucid

« back to all changes in this revision

Viewing changes to contrib/isf-qt/src/isf-qt.dox

  • Committer: Bazaar Package Importer
  • Author(s): Mark Purcell
  • Date: 2009-12-05 21:19:26 UTC
  • mfrom: (1.1.7 upstream) (0.1.8 sid)
  • Revision ID: james.westby@ubuntu.com-20091205211926-r26u8j38kysf6o2p
Tags: 2.0.2-1
https://launchpad.net/bugs/485640
* New upstream release 
  - Fixes friendly names (LP: #485640)
* Update Homepage: http://kmess.org
* Add Build-Depends: libphonon-dev | libqt4-phonon-dev (ubuntu friendly)
* kmess.1 fix lintian:hyphen-used-as-minus-sign

Show diffs side-by-side

added added

removed removed

Lines of Context:
contrib/isf-qt/src/isf-qt.dox
 
1
// Define contents of the main page
 
2
 
 
3
/**
 
4
 * @mainpage ISF-Qt - Ink Serialized Format library
 
5
 *
 
6
 * @section about About ISF-Qt
 
7
 *
 
8
 * ISF-Qt is a library, written in C++ with the Qt 4 toolkit, capable of reading
 
9
 * and writing the ISF format. ISF stands for "Ink Serialized Format", and is
 
10
 * the disk serialization format used by the Windows.Ink C# library and by the
 
11
 * TabletPC platform, but also by applications like Windows Live Messenger - which
 
12
 * uses ISF to transfer handwriting messages.
 
13
 *
 
14
 * We had the need to interpret these handwriting messages in the best possible
 
15
 * way, and started to reverse-engineer the format, with the help of existing
 
16
 * (but incomplete) libraries and specifications. What we ended up with is ISF-Qt,
 
17
 * a library which can be used to decode an ISF file or data stream, manage it
 
18
 * and the the strokes which comprise the drawing, and write ISF files/streams.
 
19
 * You can also create new drawings from scratch.
 
20
 *
 
21
 *
 
22
 * @section intro About this documentation
 
23
 * This documentation is written towards developers, to be used
 
24
 * as reference manual when writing code which uses ISF-Qt, or when developing
 
25
 * the library itself.
 
26
 * Please take your time to understand the structure of the library, its classes
 
27
 * and methods.
 
28
 *
 
29
 * Since ISF-Qt is built on top of the Qt 4 library, you will also need to
 
30
 * be familiar with it; more information can be found online at:
 
31
 * - http://doc.trolltech.com/4.3/index.html
 
32
 */