[prev in list] [next in list] [prev in thread] [next in thread]
List: kde-commits
Subject: www/sites/developer/documentation/tutorials/howto
From: Adriaan de Groot <groot () kde ! org>
Date: 2006-07-17 14:33:43
Message-ID: 1153146823.252724.711.nullmailer () svn ! kde ! org
[Download RAW message or body]
SVN commit 563411 by adridg:
Fix typos.
BUG: 130476
M +4 -3 documentation.html
--- trunk/www/sites/developer/documentation/tutorials/howto/documentation.html \
#563410:563411 @@ -1,6 +1,6 @@
<html><head><title>Chapter 4. Documentation</title><link rel="stylesheet" \
href="../common/kde-default.css" type="text/css"><meta name="generator" \
content="DocBook XSL Stylesheets V1.67.2"><link rel="start" href="index.html" \
title="KDE Developer's HOWTO"><link rel="up" href="index.html" title="KDE Developer's \
HOWTO"><link rel="prev" href="compiltip.html" title=" Compiling tips"><link \
rel="next" href="packaging.html" title="Chapter 5. Packaging and Submitting Code to \
KDE"><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta \
name="GENERATOR" content="KDE XSL Stylesheet V1.13 using libxslt"></head><body \
bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><table \
border="0" cellpadding="0" cellspacing="0" width="100%"><tr class="header"><td \
colspan="2"> </td></tr><tr id="logo"><td valign="top"><img \
src="../common/kde_logo.png" alt="KDE - The K Desktop Environment" \
width="296" height="79" border="0"></td><td valign="middle" align="center" \
id="location"><h1>Documentation</h1></td></tr></table><table width="100%" \
class="header"><tbody><tr><td align="left" class="navLeft" width="33%"><a \
accesskey="p" href="compiltip.html">Prev</a></td><td align="center" class="navCenter" \
width="34%"> </td><td align="right" class="navRight" width="33%"> <a accesskey="n" \
href="packaging.html">Next</a></td></tr></tbody></table><div class="chapter" \
lang="en"><div class="titlepage"><div><div><h2 class="title"><a \
name="documentation"></a>Chapter 4. Documentation</h2></div></div></div><div \
class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="sect1"><a \
href="documentation.html#kdoc"> KDOC: The KDE Class Documentation Tool for \
C++</a></span></dt></dl></div><p>
-It's important to document your application so that end-users can make
+It is important to document your application so that end-users can make
the most of it. You should be clear and concise. Describe any
non-standard installation, usage and UI features. There's no need to
talk about how to use the <span class="emphasis"><em>File</em></span> menu, for \
example, unless you've @@ -14,7 +14,8 @@
You should also document your widgets and other
classes. You can include comments in your header (
<code class="literal">.h</code>) files which describe each
-<code class="literal">public</code> or <code class="literal">protected</code> \
method. It +<code class="literal">public</code> or <code \
class="literal">protected</code> method. +If
you do this as you write the methods it will make the documentation
process seem easier. (It may also help you be certain about what
function(s) that method is to perform.) The script
@@ -78,4 +79,4 @@
haven't told you how to "ask for it." The <span \
xmlns:doc="http://nwalsh.com/xsl/documentation/1.0" class="option"><code \
class="option">-L</code></span> tells kdoc where its libraries are.) Type <strong \
class="userinput"><code>kdoc -h</code></strong> for more information.
-</p></div></div><table width="100%" class="bottom-nav"><tr><td width="33%" \
align="left" valign="top" class="navLeft"><a href="compiltip.html">Prev</a></td><td \
width="34%" align="center" valign="top" class="navCenter"><a \
href="index.html">Home</a></td><td width="33%" align="right" valign="top" \
class="navRight"><a href="packaging.html">Next</a></td></tr><tr><td width="33%" \
align="left" class="navLeft"> Compiling tips </td><td width="34%" align="center" \
class="navCenter"><a href="index.html">Up</a></td><td width="33%" align="right" \
class="navRight"> Packaging and Submitting Code to \
KDE</td></tr></table></body></html> \ No newline at end of file
+</p></div></div><table width="100%" class="bottom-nav"><tr><td width="33%" \
align="left" valign="top" class="navLeft"><a href="compiltip.html">Prev</a></td><td \
width="34%" align="center" valign="top" class="navCenter"><a \
href="index.html">Home</a></td><td width="33%" align="right" valign="top" \
class="navRight"><a href="packaging.html">Next</a></td></tr><tr><td width="33%" \
align="left" class="navLeft"> Compiling tips </td><td width="34%" align="center" \
class="navCenter"><a href="index.html">Up</a></td><td width="33%" align="right" \
class="navRight"> Packaging and Submitting Code to \
KDE</td></tr></table></body></html>
[prev in list] [next in list] [prev in thread] [next in thread]
Configure |
About |
News |
Add a list |
Sponsored by KoreLogic