Mailinglist Archive: opensuse-programming-de (86 mails)

< Previous Next >
DOXYGEN mit C und Strukturen
  • From: Manfred Rebentisch <mrebentisch@xxxxxxxxxxx>
  • Date: Tue, 1 Mar 2005 09:16:48 +0100
  • Message-id: <200503010916.49189.mrebentisch@xxxxxxxxxxx>
Hallo,
weiß jemand von euch, wie man richtig eine Methode in einer Struktur für
Doxygen dokumentiert? Achtung: es geht um C-Programme, nicht um C++.

Doxygen scheint mit C Probleme zu haben oder ich habe es noch nicht richtig
konfiguriert. Das Resultat ist jedenfalls murks.

Wie bringe ich Doxygen dazu, die Methode "set" (siehe Beispiel) so zu
dokumentieren, wie eine normale Funktion?

============= snippet Header ============
struct _tagCategory;
typedef struct _tagCategory TCategory, *PTCategory;

struct _tagCategory
{
uint32 checkVal1;
void* internDataM;

/**
* Setzt einen neuen Feldinhalt. \c fieldname entspricht dem Feldnamen in
* der SQL-Tabelle.
* @param obj Kategorie-Objekt
* @param fieldname Feldname der SQL-Tabelle
* @param content Zeiger auf den zu setzenden Inhalt
* @return TRUE, wenn der Inhalt fuer das Feld gueltig ist, sonst FALSE.
*/
BOOL (*set) (PTCategory obj, const char* fieldname,
const void* content);

...
};
===================================

=========== snippet Implementation =========

static BOOL st_set (PTCategory obj, const char* fieldname, const void*
content);

/*
Keine Doxygen-Dokumentation im Quellcode
*/
static BOOL st_set (PTCategory obj, const char* fieldname, const void*
content)
{
/* Implementation */
}
===================================


Manfred

--
COMPARAT Software-Entwicklungs-GmbH
BACKUP-SERVER testen: https://bs0005.comparat.de/bs/index.php

< Previous Next >
Follow Ups