<chapter id="documentation">
<title
>Dokumentation</title>

<para
>Dokumentation är tyvärr en av de mest förbisedda delarna av programmering. Ändå så erbjuder riktigt upprättad och underhållen intern och extern dokumentation ytterst värdefull hjälp. </para>

<para
>Dokumentation har flera aspekter. Det finns <itemizedlist>
  <listitem
><para
><emphasis
>intern projektdokumentation</emphasis
>, som i huvudsak består av <itemizedlist>
    <listitem
><para
><emphasis
>kommentarer</emphasis
> i deklarationsfiler och källkodsfiler </para
></listitem>
    <listitem
><para
><emphasis
>Intern dokumentation av programmeringsgränssnittet</emphasis
> för projektet, som har skapats från programfilerna av särskilda verktyg, t.ex. &doxygen; </para
></listitem>
  </itemizedlist>
  </para
></listitem>
  <listitem
><para
><emphasis
>extern projektdokumentation</emphasis
>, som bland annat består av <itemizedlist>
    <listitem
><para
><emphasis
>extern dokumentation av programmeringsgränssnitt</emphasis
>, till exempel för gemensamma systembibliotek (&kde;, &Qt;, etc.) </para
></listitem>
    <listitem
><para
>all övrig dokumentation (manualer för programspråk, allmän systeminformation, handledningar och liknande) </para
></listitem>
  </itemizedlist>
  </para
></listitem>
</itemizedlist>
</para>
<para
>All denna dokumentation ska vara enkel att underhålla och lätt tillgänglig så fort du behöver den. &kdevelop; har stöd för just detta. </para>

<!-- ### doc browser, notes on internal documentation, how to profit from Doxygen -->

<sect1 id="docbrowser">
<title
>Dokumentationsbläddraren</title>


<figure id="screenshot-doctreeview" float="1">
<title
>En skärmbild av dokumentationsträdet</title>
<mediaobject>
<imageobject
><imagedata fileref="doctreeview.png"/></imageobject>
</mediaobject>
</figure>

</sect1
> <!-- docbrowser -->

</chapter
> <!-- documentation -->