Dokumentaci k vloženým programům

Programy a jejich rozhraní příkazového řádku můžete zdokumentovat pomocí vložené dokumentace.

Značky
PROGRAM

Definuje začátek dokumentace k programu.

@short_description:

Definuje krátký popis programu. (volitelné)

@synopsis:

Definuje argumenty nebo seznam argumentů, které program přebírá. (volitelné)

@see_also:

Část stránky oddílu „Viz také“. (volitelné)

@arg:

Argument(y) předávané do programu a jejich popis. (volitelné)

Description:

Úplný popis programu.

Returns:

Specifikuje, jakou hodnotu či více hodnot program vrací. (volitelné)

3.4.1. Příklad dokumentace k programu.

Příklad 3-12Komentářový blok pro program
/**
 * PROGRAM:test-program
 * @short_description: Testovací program
 * @synopsis: test-program [*OPTIONS*...] --arg1 *arg* *FILE*
 * @see_also: test(1)
 * @--arg1 *arg*: nastaví arg1 do *arg*
 * @--arg2 *arg*: nastaví arg2 do *arg*
 * @-v, --version: Vypíše verzi programu
 * @-h, --help: Vypíše nápovědu k programu
 *
 * Úplný popis programu.
 *
 * Returns: Vrací nulu při úspěchu, nenulovou hodnotu při selhání.
 */
int main(int argc, char *argv[])
{
	return 0;
}