Infogad programdokumentation

Du kan dokumentera program och deras kommandoradsgränssnitt med infogad dokumentation.

Taggar
PROGRAM

Definierar början av programdokumentationen.

@short_description:

Definierar en kort beskrivning av programmet. (Valfritt)

@synopsis:

Definierar argumenten, eller en lista av argument som programmet kan ta. (Valfritt)

@see_also:

Se vidare i manualavsnitt. (Valfritt)

@arg:

Argument som skickas vidare till programmet och deras beskrivningar. (Valfritt)

Beskrivning:

En längre beskrivning av programmet.

Returns:

Ange vilka värden programmet returnerar. (Valfritt)

3.4.1. Exempel på programdokumentation.

Exempel 3-12Dokumentationsblock för program
/**
 * PROGRAM:test-program
 * @short_description: Ett testprogram
 * @synopsis: test-program [*FLAGGOR*...] --arg1 *arg* *FIL*
 * @see_also: test(1)
 * @--arg1 *arg*: ställ in arg1 på *arg*
 * @--arg2 *arg*: ställ in arg2 på *arg*
 * @-v, --version: Skriv ut versionsinformation
 * @-h, --help: Skriv ut hjälpmeddelandet
 *
 * En längre beskrivning av programmet.
 *
 * Returns: Noll vid framgång, icke-noll vid fel
 */
int main(int argc, char *argv[])
{
	return 0;
}