Doxygen Problem

Antworten
Nachricht
Autor
Hank
Beiträge: 18
Registriert: 25. Jun 2007 15:16

Doxygen Problem

#1 Beitrag von Hank » 18. Sep 2007 8:13

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;
}

schubsi

#2 Beitrag von schubsi » 05. Okt 2007 19:30

Werden Parameter nicht mit
\param
eingebunden?

Muss aber auch nachsehen, nicht mehr genau weiss.

tom servo
Beiträge: 225
Registriert: 01. Jun 2004 9:36

#3 Beitrag von tom servo » 06. Okt 2007 13:34

So läuft das wohl besser.
Bin aber schon stark eingerostet in doxygen. ;)

Code: Alles auswählen

#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 &#40; int argc, char *argv&#91;&#93; &#41;
 * @param argc &#58; number of command line arguments.
 * @param argv &#58; command line argument vector.
 * @return always 0.
 */
int main &#40; int argc, char *argv&#91;&#93; &#41; &#123;
	printf&#40;"%s\n", message&#41;;

	return 0;
&#125;
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: Alles auswählen

\param
und

Code: Alles auswählen

@param
sind gleichbedeutend.

cu

Antworten