DOXYGEN

nippler92

Heyho,

ich hoffe ich bin hier in dem Bereich richtig

Ich möchte meine Programme nun endlich mal richtig dokumentieren und habe DOXYGEN gefunden um Dokumentationen von C Programmen gut und übersichtlich in html und pdf files zu packen.

ein bisschen was hab ich auch schon selber hin bekommen aber halt nur ein bisschen...

Ich hab mein Test Prog.

#include <stdio.h>
#include <stdlib.h>

/// Das ist ein Kommentar
void FKT1(int Wert1) ///<FKT1
{
  printf("Wert1 ist: %d\n",Wert1);
}

void FKT2(int Wert2) ///<FKT2
{
  printf("Wert2 ist: %d\n",Wert2);
}

void FKT3(int Wert3) ///<FKT3
{
  printf("Wert3 ist: %d\n",Wert3);
}

void FKT4(int Wert4) ///<FKT4
{
  printf("Wert4 ist: %d\n",Wert4);
}

int main()  ///<main
{
  int Wert1=1;
  int Wert2=2;
  int Wert3=3;
  int Wert4=4;

  FKT1(Wert1);
  FKT1(Wert2);
  FKT1(Wert3);
  FKT1(Wert4);

  printf("Ende\n");
  return 0;
}

Dann erstelle ich ne cfg datei mit

doxygen -g test.config

Frage1 : woher weiß man für welche Quelldatei die Cfg angelegt wird?
Wenn ich Beispielsweise test.c und test1.c im Verzeichnis habe und von Test1.c ne Dokumentation erstellen will.

Als nächstes wird dann gebaut aber was?!?
zur Frage1 denke ich das man auf die Datei die dokumentiert werden soll logischerweise irgendwo verweisen muss aber wo? Es wird ja auch nichts gebaut bis auf ne leere html Seite...

doxygen test.config

Frage2: ich habe nen Prog mit vielen ausgelagerten Funktionen (alle im selben Ordner) bvesteht dann die Möglichkeit das man alles zusammen in eine Dokumentation bekommt oder muss man für jede Funktion eine eig. Dok. erstellen?

Mfg nippler92

knivil

Benutze doxywizard!

Normalerweise wird die Doku fuer Projekte mit vielen Dateien erstellt. Was zu dokumentieren ist, steht in der Headerdatei. C-Dateien a la Doxygen zu dokumentieren, macht keinen Sinn, koennen aber im Html-Dokument verlinkt werden.