Hinweis: Das Forum wird geschlossen! Neue Registrierungen sind nicht mehr möglich!

 Zurück zu Pro-Linux   Foren-Übersicht   FAQ     Suchen    Mitgliederliste
Doxygen Problem

 
Neuen Beitrag schreiben   Auf Beitrag antworten    Pro-Linux Foren-Übersicht -> Programmieren - C
Vorheriges Thema anzeigen :: Nächstes Thema anzeigen  
Autor Nachricht
Hank



Anmeldungsdatum: 25.06.2007
Beiträge: 18

BeitragVerfasst am: 18. Sep 2007 8:13   Titel: Doxygen Problem

Moin Moin!

Um die Fähigkeiten von Doxygen auszuprobieren, wollte ich ein kleines Hello-World-Programm einmal dokumentieren. Leider klappte es nicht so richtig, und es wird keine Funktionsdokumentation erstellt. Statt dessen wird in der Dokumentation lediglich der Quellcode eingebunden.

Hat jemand einen Tip, woran dies liegen könnte?

Vielen Dank und freundliche Grüße
Hank

Hier der Code:

#include <stdio.h>

/**
* Just a global character array.
*/
char *message = "A little message.";


/** A little program for doxygen testing...
*
* @param argc : number of command line arguments.
* @param argv : command line argument vector.
* @return always 0.
*/
int main(int argc, char *argv[])
{
printf("%s\n", message);

return 0;
}
 
Benutzer-Profile anzeigen Private Nachricht senden

schubsi
Gast





BeitragVerfasst am: 05. Okt 2007 19:30   Titel:

Werden Parameter nicht mit
Zitat:
\param
eingebunden?

Muss aber auch nachsehen, nicht mehr genau weiss.
 

tom servo



Anmeldungsdatum: 01.06.2004
Beiträge: 225

BeitragVerfasst am: 06. Okt 2007 13:34   Titel:

So läuft das wohl besser.
Bin aber schon stark eingerostet in doxygen. Wink
Code:

#include <stdio.h>

/*!
 * @mainpage title
 *
 * @section section__1
 *
 * @subsection subsection__1
 *
 */

/*!
 * @var *message
 * @brief global string variable
 */
char *message = "A little message.";

/*! A little program for doxygen testing...
 * @file hello.c
 * @fn main ( int argc, char *argv[] )
 * @param argc : number of command line arguments.
 * @param argv : command line argument vector.
 * @return always 0.
 */
int main ( int argc, char *argv[] ) {
   printf("%s\n", message);

   return 0;
}

Aber mal ehrlich, wirklich mit doygen beschäftigt hast du dich nicht?
Der mainpage-Kram erzeugt die index.html und darf/muss somit nur einmalig im Projekt auftauchen. @file steht für den Dateinamen und @fn für den Funktionsnamen, der Rest ist wohl selbsterklärend.

@schubsi
Ich glaube
Code:

\param
und
Code:

@param

sind gleichbedeutend.

cu
 
Benutzer-Profile anzeigen Private Nachricht senden

Beiträge vom vorherigen Thema anzeigen:   
     Pro-Linux Foren-Übersicht -> Programmieren - C Alle Zeiten sind GMT + 1 Stunde
Seite 1 von 1

 
Gehen Sie zu:  

Powered by phpBB © phpBB Group
pro_linux Theme © 2004 by Mandaxy