summaryrefslogtreecommitdiffstats
path: root/doc/html/activeqt-tools-dumpdoc.html
blob: 5f9477c7024f1638fe826e8a5c816ffbec5d49b9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<!-- /home/espenr/tmp/qt-3.3.8-espenr-2499/qt-x11-free-3.3.8/extensions/activeqt/tools/dumpdoc/dumpdoc.doc:1 -->
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>The DumpDoc Tool</title>
<style type="text/css"><!--
fn { margin-left: 1cm; text-indent: -1cm; }
a:link { color: #004faf; text-decoration: none }
a:visited { color: #672967; text-decoration: none }
body { background: #ffffff; color: black; }
--></style>
</head>
<body>

<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr bgcolor="#E5E5E5">
<td valign=center>
 <a href="index.html">
<font color="#004faf">Home</font></a>
 | <a href="classes.html">
<font color="#004faf">All&nbsp;Classes</font></a>
 | <a href="mainclasses.html">
<font color="#004faf">Main&nbsp;Classes</font></a>
 | <a href="annotated.html">
<font color="#004faf">Annotated</font></a>
 | <a href="groups.html">
<font color="#004faf">Grouped&nbsp;Classes</font></a>
 | <a href="functions.html">
<font color="#004faf">Functions</font></a>
</td>
<td align="right" valign="center"><img src="logo32.png" align="right" width="64" height="32" border="0"></td></tr></table><h1 align=center>The DumpDoc Tool</h1>

 

The <tt>dumpcoc</tt> tool generates Qt-style documentation for any
COM object and writes it into the file specified.
<p> Call <tt>dumpdoc</tt> with the following command line parameters:
<p> <center><table cellpadding="4" cellspacing="2" border="0">
<tr bgcolor="#a2c511">
<th valign="top">Option
<th valign="top">Result
<tr bgcolor="#f0f0f0">
<td valign="top">-o file
<td valign="top">Writes output to <em>file</em>
<tr bgcolor="#d0d0d0">
<td valign="top">object
<td valign="top">Generate documentation for <em>object</em>
<tr bgcolor="#f0f0f0">
<td valign="top">-v
<td valign="top">Print version information
<tr bgcolor="#d0d0d0">
<td valign="top">-h
<td valign="top">Print help
</table></center>
<p> <em>object</em> must be an object installed on the local machine (ie.
remote objects are not supported), and can include subobjects
accessible through properties, ie.
<tt>Outlook.Application/Session/CurrentUser</tt>
<p> The generated file will be an HTML file using Qt documentation
style.
<p> To build the tool you must first build the
<a href="qaxcontainer.html">QAxContainer</a> library.
Then run your make tool in <tt>tools/dumpdoc</tt>.
<p>See also <a href="activeqt-tools.html">ActiveQt Tools</a>.

<!-- eof -->
<p><address><hr><div align=center>
<table width=100% cellspacing=0 border=0><tr>
<td>Copyright &copy; 2007
<a href="troll.html">Trolltech</a><td align=center><a href="trademarks.html">Trademarks</a>
<td align=right><div align=right>Qt 3.3.8</div>
</table></div></address></body>
</html>