ArDoc • DSG

Analisi

REQ cat • nome

Disegno Logico
DSG cat • nome
MAN cat • nome

Disegno Tecnico
DST cat • nome
SYS cat • nome

DAF nome
DAT nome
KON nome

CLA nome
FUN nome

SRC cat • nome

Disegno Utente
DSU cat • nome

JOB nome
UUI nome
RPT nome

Varie
AMM cat • nome
QCL cat • nome
RIS cat • nome

e-mail

Mac -- Macro funzione

Tramite il tag @Mac si documenta una macro usata con la semantica di una funzione. Prevede il formato 1. Genera un documento FUN -- Funzioni.

MAC -- Tags
Sub-Tag	Parametri	Descrizione
@Mac	Stringa Nome	Systema, nome e descrizione della macro. Se il nome � assente viene prelevato da @Proto.
@Name	Text	Nome della Constante
@Sys	Text	Systema di appartenenza
@Auth	Text	Autore
@DtIni	Date	Data di creazione della definizione. Se assente prende la data del sorgente.
@DtMod	Date	Data di Modifica. Se assente prende la data di creazione.
@Proto	Text	Prototipo della Macro.
@Define	Text	Il testo C della define della macro.
@Param	name IN\|OUT Text	Descrizione del parametro.
@Return	valore text	Descrizione dei valori di ritorno.
@Descr	Text	Descrizione della macro.
@/Descr		Fine descrizione

Esempio di utilizzo di questo tag:

/**
@Mac     Abnormal program termination
@Proto   void AbortAR(char *msg)
@Param   msg      IN  Message to be shown, can be NULL
@Define  #define AbortAR(msg)   abort_ar(AR_HERE,(msg))
@Descr   
 This macro calls #fun(abort_ar) to terminate the program. The purpose of the
 macro is to <I>automate</I> the first three parameters by using the 
 #mac(AR_HERE) macro.
@/Descr                     ...
**/

Links verso

Disegno Logico
: DTD.FUN • FUN -- Funzioni
: src.tag1 • Formato 1 dei commenti Tag
: tag.name • Il formato stringa-nome

Links da

Disegno Logico
: tag • Riepilogo dei Tag
Disegno Utente
: pio.dcl.fun.mac • fun.c: Macro C