summaryrefslogtreecommitdiffstats
path: root/tde-i18n-et/docs/kdevelop/kdevelop/documentation.docbook
diff options
context:
space:
mode:
Diffstat (limited to 'tde-i18n-et/docs/kdevelop/kdevelop/documentation.docbook')
-rw-r--r--tde-i18n-et/docs/kdevelop/kdevelop/documentation.docbook73
1 files changed, 73 insertions, 0 deletions
diff --git a/tde-i18n-et/docs/kdevelop/kdevelop/documentation.docbook b/tde-i18n-et/docs/kdevelop/kdevelop/documentation.docbook
new file mode 100644
index 00000000000..ab9d1a072bc
--- /dev/null
+++ b/tde-i18n-et/docs/kdevelop/kdevelop/documentation.docbook
@@ -0,0 +1,73 @@
+<chapter id="documentation">
+<title
+>Dokumentatsioon</title>
+
+<para
+>Dokumentatsioon kuulub paraku programmeerimise juures enamasti väga vähest tähelepanu pälvivate asjade hulka. Ometi on korralikult loodud ja hooldatud seesmisest ja välisest dokumentatsioonist väga suur abi ja kasu. </para>
+
+<para
+>Dokumentatsioon võib esineda mitmel kujul: <itemizedlist>
+ <listitem
+><para
+><emphasis
+>projekti seesmine dokumentatsioon</emphasis
+>, mille moodustavad peamiselt <itemizedlist>
+ <listitem
+><para
+><emphasis
+>kommentaarid</emphasis
+> päise/lähtekoodifailides </para
+></listitem>
+ <listitem
+><para
+><emphasis
+>seesmine &API; dokumentatsioon</emphasis
+>, mille sinu projektile loob programmifailide põhjal mõni spetsiaalne tööriist, &eg; &doxygen; </para
+></listitem>
+ </itemizedlist>
+ </para
+></listitem>
+ <listitem
+><para
+><emphasis
+>projekti väline dokumentatsioon</emphasis
+>, mille moodustavad muu hulgas <itemizedlist>
+ <listitem
+><para
+><emphasis
+>väline &API; dokumentatsioon</emphasis
+> &eg; üldiste süsteemsete teekide kohta (&kde;, &Qt; &etc;) </para
+></listitem>
+ <listitem
+><para
+>mis tahes muu dokumentatsioon (programmeerimiskeele käsiraamatud, süsteemi üldine info, HOWTO-d ja nii edasi) </para
+></listitem>
+ </itemizedlist>
+ </para
+></listitem>
+</itemizedlist>
+</para>
+<para
+>Kogu dokumentatsioon peab olema hõlpsasti hooldatav ja vajaduse korral alati käepärast. &kdevelop; võimaldab seda kõike. </para>
+
+<!-- ### doc browser, notes on internal documentation, how to profit from Doxygen -->
+
+<sect1 id="docbrowser">
+<title
+>Dokumentatsioonisirvija</title>
+
+
+<figure id="screenshot-doctreeview" float="1">
+<title
+>Dokumentatsioonipuu pilt</title>
+<mediaobject>
+<imageobject
+><imagedata fileref="doctreeview.png"/></imageobject>
+</mediaobject>
+</figure>
+
+</sect1
+> <!-- docbrowser -->
+
+</chapter
+> <!-- documentation -->