blob: 735195fc1b1edc6437f6e379609a66a1b12d3238 (
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
|
<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, ⪚ &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
> ⪚ ü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. &tdevelop; 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 -->
|
