La stringa-nome è un formato che permette di indicare sinteticamente:
- Il sistema.
- Il nome.
- Il titolo.
Il formato si basa sui seguenti assunti:
- Il sistema è una sola parola.
- Il nome è una sola parola.
- Il titolo è composto da più parole.
Nell'esempio che segue vengono illustrate le diverse forme che può assumere la stringa-nome.
@Kon System :: Name : Short Description
@Kon System :: Short Description
@Kon System :: Name :
@Kon System ::
@Kon Name : Short Description
@Kon Name :
@Kon Short Description
@Kon Short Description
@Sys System
@Name Name
|
Un esempio di utilizzo.
/**
@Kon Pointers :: NULLP : A null value for a data pointer
@Descr Additional macro that redefine the standard NULL.<P>** DEPRICATED **
@/Descr
**/
#define NULLP NULL
/** @/Kon **/
/**
@Kon A null value for a data pointer
@Name NULLP
@Sys Pointers
@Descr Additional macro that redefine the standard NULL.<P>** DEPRICATED **
@/Descr
**/
#define NULLP NULL
/** @/Kon **/
|
e-mail