/usr/share/doc/libtse3-dev/KDOC.html is in libtse3-dev 0.3.1-4.2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 | <html>
<head>
<title>TSE3 library API reference</title>
</head>
<body bgcolor=#ffffff text=#000000>
<table width=100% cellspacing=0 cellpadding=1 border=0 bgcolor=#000000><tr><td>
<table width=100% cellspacing=0 cellpadding=1 border=0><tr><td valign=center bgcolor=#c8d559>
<table width=100% cellspacing=0 cellpadding=0 border=0><tr>
<td align=left width=30%><b> TSE3 documentation<b></td>
<td align=center width=30%>Version 0.3.1</td>
<td align=right width=30%>
<a href="index.html"><b>Index</b></a>
<a href="api/index.html">API</a>
<a href="Version.html">Version</a>
<a href="Structure.html">Structure</a>
</td>
</tr></table>
</td></tr></table>
</td></tr></table>
<h1>TSE3 library API reference</h1>
<p>
The TSE3 library provides extensive on-line documentation which is
extracted by the
<a href="http://www.ph.unimelb.edu.au/~ssk/kde/kdoc/">KDOC</a> or
the <a href="http://www.doxygen.org/">Doxygen</a> tool. The format
of each tool's output is different; you may prefer one to the other.
The information contained in each should be identical. Doxygen output
may generate inheritance hierarchy diagrams (depending on your particular
installation) which you may find more useful.
<p>
You must build the TSE3 documentation to access this information.
<h3>Building Doxygen documentation</h3>
<p>
If you have Doxygen installed, you can enter the <code>doc</code>
directory, and type <code>make tse3-doxygen</code>.
<h3>Building KDOC documentation</h3>
<p>
You do this by entering the <code>doc</code> directory and
typing <code>make tse3-kdoc</code>. This builds the main TSE3 API
reference which details every single class in TSE3. You can also
build a reference for each namespace individually, type <code>make
tse3-kdoc-libs</code>.
<p>
The easy way is to do a <code>make tse3-kdoc-all</code> which builds
both.
<p>
You will need to have a copy of KDOC installed that correctly handles
namespaces (2.0a35 or later works).
<p>
The comprehensive KDOC API reference provides the following information.
<ul>
<li><a href="api/index.html">Index</a> (start here)
<li><a href="api/index-long.html">Annotated list</a>
<li><a href="api/header-list.html">File list</a>
<li><a href="api/all-globals.html">Globals</a>
<li><a href="api/hier.html">Inheritance hierarchy</a>
</ul>
<p>
The individual namespace references are:
<ul>
<li><a href="api/lib.TSE3/index.html">TSE3 namespace</a>
<li><a href="api/lib.App/index.html">App namespace</a>
<li><a href="api/lib.Cmd/index.html">Cmd namespace</a>
<li><a href="api/lib.Plt/index.html">Plt namespace</a>
<li><a href="api/lib.Util/index.html">Util namespace</a>
</ul>
<p>
You can remove all of the documentation using
<code>make tse3-kdoc-clean</code>.
<body bgcolor=#ffffff text=#000000>
<table width=100% cellspacing=0 cellpadding=1 border=0 bgcolor=#000000><tr><td>
<table width=100% cellspacing=0 cellpadding=1 border=0><tr><td valign=center bgcolor=#c8d559>
<table width=100% cellspacing=0 cellpadding=0 border=0><tr>
<td align=left width=30%> © Pete Goodliffe, 2001-2003</td>
<td align=center width=30%><a href="Copyright.html">Copyright</a></td>
<td align=right width=30%><a href="Psalm150.html">Psalm 150</a> </td>
</tr></table>
</td></tr></table>
</td></tr></table>
</body>
</html>
|