|
0
|
1 |
/****************************************************************************
|
|
|
2 |
**
|
|
|
3 |
** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
|
|
|
4 |
** All rights reserved.
|
|
|
5 |
** Contact: Nokia Corporation (qt-info@nokia.com)
|
|
|
6 |
**
|
|
|
7 |
** This file is part of the documentation of the Qt Toolkit.
|
|
|
8 |
**
|
|
|
9 |
** $QT_BEGIN_LICENSE:LGPL$
|
|
|
10 |
** No Commercial Usage
|
|
|
11 |
** This file contains pre-release code and may not be distributed.
|
|
|
12 |
** You may use this file in accordance with the terms and conditions
|
|
|
13 |
** contained in the Technology Preview License Agreement accompanying
|
|
|
14 |
** this package.
|
|
|
15 |
**
|
|
|
16 |
** GNU Lesser General Public License Usage
|
|
|
17 |
** Alternatively, this file may be used under the terms of the GNU Lesser
|
|
|
18 |
** General Public License version 2.1 as published by the Free Software
|
|
|
19 |
** Foundation and appearing in the file LICENSE.LGPL included in the
|
|
|
20 |
** packaging of this file. Please review the following information to
|
|
|
21 |
** ensure the GNU Lesser General Public License version 2.1 requirements
|
|
|
22 |
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
|
|
|
23 |
**
|
|
|
24 |
** In addition, as a special exception, Nokia gives you certain additional
|
|
|
25 |
** rights. These rights are described in the Nokia Qt LGPL Exception
|
|
|
26 |
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
|
|
|
27 |
**
|
|
|
28 |
** If you have questions regarding the use of this file, please contact
|
|
|
29 |
** Nokia at qt-info@nokia.com.
|
|
|
30 |
**
|
|
|
31 |
**
|
|
|
32 |
**
|
|
|
33 |
**
|
|
|
34 |
**
|
|
|
35 |
**
|
|
|
36 |
**
|
|
|
37 |
**
|
|
|
38 |
** $QT_END_LICENSE$
|
|
|
39 |
**
|
|
|
40 |
****************************************************************************/
|
|
|
41 |
|
|
|
42 |
/*!
|
|
|
43 |
\page activeqt-dumpdoc.html
|
|
|
44 |
\title The dumpdoc Tool (ActiveQt)
|
|
|
45 |
|
|
|
46 |
\ingroup activeqt-tools
|
|
|
47 |
|
|
|
48 |
\keyword dumpdoc
|
|
|
49 |
|
|
|
50 |
The \c dumpdoc tool generates Qt-style documentation for any
|
|
|
51 |
COM object and writes it into the file specified.
|
|
|
52 |
|
|
|
53 |
Call \c dumpdoc with the following command line parameters:
|
|
|
54 |
|
|
|
55 |
\table
|
|
|
56 |
\header
|
|
|
57 |
\i Option
|
|
|
58 |
\i Result
|
|
|
59 |
\row
|
|
|
60 |
\i -o file
|
|
|
61 |
\i Writes output to \e file
|
|
|
62 |
\row
|
|
|
63 |
\i object
|
|
|
64 |
\i Generate documentation for \e object
|
|
|
65 |
\row
|
|
|
66 |
\i -v
|
|
|
67 |
\i Print version information
|
|
|
68 |
\row
|
|
|
69 |
\i -h
|
|
|
70 |
\i Print help
|
|
|
71 |
\endtable
|
|
|
72 |
|
|
|
73 |
\e object must be an object installed on the local machine (ie.
|
|
|
74 |
remote objects are not supported), and can include subobjects
|
|
|
75 |
accessible through properties, ie.
|
|
|
76 |
\c Outlook.Application/Session/CurrentUser
|
|
|
77 |
|
|
|
78 |
The generated file will be an HTML file using Qt documentation
|
|
|
79 |
style.
|
|
|
80 |
|
|
|
81 |
To build the tool you must first build the QAxContainer library.
|
|
|
82 |
Then run your make tool in \c tools/dumpdoc.
|
|
|
83 |
*/
|