Hvordan man får fat i programmeringsgrænsefladen for KDevelop

Programmeringsgrænsefladen, “Application Program Interface” på engelsk, ofte forkortet til API, er i virkeligheden en følge af beskrivelser (dvs. kaldmodeller) som et program bruger for at få adgang til operativsystem og andre tjenester. I vort tilfælde er en mere omfattende definition dog blevet anvendt. Programmeringsgrænsefladen for et KDE- eller Qt™-program er en abstraktion af klasser og metodegrænseflader, en oversigt som kan bruges som opslagsbog for navigation i kildekoden.

Der er en version af den seneste programmeringsgrænseflade på KDevelops hjemmeside. Den opdateres automatisk hvert døgn så at du kan følge med.

Desværre bruges denne version bedst kun til at læse via internettet. Du kan ligesågodt bygge din egen dokumentation af programmeringsgrænsefladen fra kildekoden for KDevelop. For at gøre det, skal du fortælle automake systemet hvor KDELIBS API findes på dit. Dette opnås med det særlige flag --with-kdelibsdoxy-dir til configure-kommandoen når du forbereder at kompilere KDevelop's kildekode:

~/kde3src/kdevelop> ./configure --(flag-som-sædvanligt) \
--with-kdelibsdoxy-dir=$KDEDIR/share/doc/HTML/en/kdelibs-apidocs

(make erstatter den globale $KDEDIR med den egentlige KDE-mappe). Udfør derefter kommandoen make som sædvanligt. Efter at det integrerede udviklingsmiljø KDevelop er bygget, har du mulighed for også at bygge programmeringsgrænsefladen. For at gøre det skal du skrive:

~/kde3src/kdevelop> make apidocs

Dette bygger en Doxyfile i basismappen for KDevelop, som derefter behandles af programmet doxygen for at oprette en hel del .html-filer for programmeringsgrænsefladen. Når den ganske lange byggeproces for programmeringsgrænsefladen til sidst er klar, skal du installere programmeringsgrænsefladen præcis som du skal installere selve det integrerede udviklingsmiljø KDevelop. Få rettigheder som systemadministrator om nødvendigt med:

~/kde3src/kdevelop> su

og angive systemadministratorens kodeord. Installér derefter dokumentationsfilerne:

~/kde3src/kdevelop> make install-apidox

Når dette er gjort, informerer make dig om mappen hvor du til sidst kan kigge på indholdet i dokumentationen for programmeringsgrænsefladen. Bemærk adressen, eftersom du kan bruge den fra Konqueror samt inde i KDevelop, hvis du har indstillet den egne kildekode for KDevelop som projektet at arbejde med.

Bemærk

Du vil mest sandsynligt se en masse advarsler og/eller fejlmeddelelser under API byggekørslen for Doxygen. Bedst at ignorere dem, de er kun af interesse for KDevelop-udviklerne. Hvis API-generingen nogensinde bliver færdig, så vil .html API-filerne kunne bruges.