| 1 | /****************************************************************************
|
|---|
| 2 | **
|
|---|
| 3 | ** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
|
|---|
| 4 | ** Contact: Qt Software Information (qt-info@nokia.com)
|
|---|
| 5 | **
|
|---|
| 6 | ** This file is part of the documentation of the Qt Toolkit.
|
|---|
| 7 | **
|
|---|
| 8 | ** $QT_BEGIN_LICENSE:LGPL$
|
|---|
| 9 | ** Commercial Usage
|
|---|
| 10 | ** Licensees holding valid Qt Commercial licenses may use this file in
|
|---|
| 11 | ** accordance with the Qt Commercial License Agreement provided with the
|
|---|
| 12 | ** Software or, alternatively, in accordance with the terms contained in
|
|---|
| 13 | ** a written agreement between you and Nokia.
|
|---|
| 14 | **
|
|---|
| 15 | ** GNU Lesser General Public License Usage
|
|---|
| 16 | ** Alternatively, this file may be used under the terms of the GNU Lesser
|
|---|
| 17 | ** General Public License version 2.1 as published by the Free Software
|
|---|
| 18 | ** Foundation and appearing in the file LICENSE.LGPL included in the
|
|---|
| 19 | ** packaging of this file. Please review the following information to
|
|---|
| 20 | ** ensure the GNU Lesser General Public License version 2.1 requirements
|
|---|
| 21 | ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
|
|---|
| 22 | **
|
|---|
| 23 | ** In addition, as a special exception, Nokia gives you certain
|
|---|
| 24 | ** additional rights. These rights are described in the Nokia Qt LGPL
|
|---|
| 25 | ** Exception version 1.0, included in the file LGPL_EXCEPTION.txt in this
|
|---|
| 26 | ** package.
|
|---|
| 27 | **
|
|---|
| 28 | ** GNU General Public License Usage
|
|---|
| 29 | ** Alternatively, this file may be used under the terms of the GNU
|
|---|
| 30 | ** General Public License version 3.0 as published by the Free Software
|
|---|
| 31 | ** Foundation and appearing in the file LICENSE.GPL included in the
|
|---|
| 32 | ** packaging of this file. Please review the following information to
|
|---|
| 33 | ** ensure the GNU General Public License version 3.0 requirements will be
|
|---|
| 34 | ** met: http://www.gnu.org/copyleft/gpl.html.
|
|---|
| 35 | **
|
|---|
| 36 | ** If you are unsure which license is appropriate for your use, please
|
|---|
| 37 | ** contact the sales department at qt-sales@nokia.com.
|
|---|
| 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 | */
|
|---|
