diff options
| author | toma <toma@283d02a7-25f6-0310-bc7c-ecb5cbfe19da> | 2009-11-25 17:56:58 +0000 |
|---|---|---|
| committer | toma <toma@283d02a7-25f6-0310-bc7c-ecb5cbfe19da> | 2009-11-25 17:56:58 +0000 |
| commit | 114a878c64ce6f8223cfd22d76a20eb16d177e5e (patch) | |
| tree | acaf47eb0fa12142d3896416a69e74cbf5a72242 /doc/kdevelop/documentation.docbook | |
| download | tdevelop-114a878c64ce6f8223cfd22d76a20eb16d177e5e.tar.gz tdevelop-114a878c64ce6f8223cfd22d76a20eb16d177e5e.zip | |
Copy the KDE 3.5 branch to branches/trinity for new KDE 3.5 features.
BUG:215923
git-svn-id: svn://anonsvn.kde.org/home/kde/branches/trinity/kdevelop@1054174 283d02a7-25f6-0310-bc7c-ecb5cbfe19da
Diffstat (limited to 'doc/kdevelop/documentation.docbook')
| -rw-r--r-- | doc/kdevelop/documentation.docbook | 57 |
1 files changed, 57 insertions, 0 deletions
diff --git a/doc/kdevelop/documentation.docbook b/doc/kdevelop/documentation.docbook new file mode 100644 index 00000000..eed065b0 --- /dev/null +++ b/doc/kdevelop/documentation.docbook @@ -0,0 +1,57 @@ +<chapter id="documentation"> +<title>Documentation</title> + +<para> +Documention unfortunately belongs to the most-overlooked programming +issues. Yet, once properly set up and maintained internal and external +documentation provides most valuable help. +</para> + +<para> +Documentation has multiple facets. There is +<itemizedlist> + <listitem><para> + <emphasis>project internal documentation</emphasis>, mainly consisting of + <itemizedlist> + <listitem><para> + <emphasis>comments</emphasis> in header/source files + </para></listitem> + <listitem><para> + <emphasis>internal &API; documentation</emphasis> of your project + generated from the program file by special tools, ⪚ &doxygen; + </para></listitem> + </itemizedlist> + </para></listitem> + <listitem><para> + <emphasis>project external documentation</emphasis>, comprising among others + <itemizedlist> + <listitem><para> + <emphasis>external &API; documentation</emphasis> of ⪚ common system libraries (&kde;, &Qt;, &etc;) + </para></listitem> + <listitem><para> + any other documentation (programming language manuals, general system information, how-to articles and the like) + </para></listitem> + </itemizedlist> + </para></listitem> +</itemizedlist> +</para> +<para> +All this documentation should be easily maintainable and ready at hand whenever you need it. &kdevelop; has provisions for just this. +</para> + +<!-- ### doc browser, notes on internal documentation, how to profit from Doxygen --> + +<sect1 id="docbrowser"> +<title>The Documentation Browser</title> + + +<figure id="screenshot-doctreeview" float="1"> +<title>A Screenshot of the Documentation Tree</title> +<mediaobject> +<imageobject><imagedata fileref="doctreeview.png"/></imageobject> +</mediaobject> +</figure> + +</sect1> <!-- docbrowser --> + +</chapter> <!-- documentation --> |