Documentação de programa em-linha

Você pode documentar programas e sua interface de linha de comando usando documentação em-linha.

Tags
PROGRAM

Define o início da documentação de um programa.

@short_description:

Define uma descrição breve do programa. (Opcional)

@synopsis:

Define os argumentos, ou lista de argumentos, que o programa pode receber. (Opcional)

@see_also:

A seção “Veja Também” (See Also) de páginas de manual. (Opcional)

@arg:

Argumento(s) passado(s) para o programa e sua descrição. (Opcional)

Description:

Um descrição mais longa do programa.

Returns:

Especifique quais valor(es) o programa retorna. (Opcional)

3.4.1. Exemplo de documentação de programa.

Example 3-12Bloco de documentação de programa
/**
 * PROGRAM:programa-teste
 * @short_description: Um programa teste
 * @synopsis: programa-teste [*OPÇÕES*...] --arg1 *arg* *ARQUIVO*
 * @see_also: teste(1)
 * @--arg1 *arg*: define arg1 para *arg*
 * @--arg2 *arg*: define arg2 para *arg*
 * @-v, --version: Exibe o número da versão
 * @-h, --help: Exibe a mensagem de ajuda
 *
 * Descrição longa do programa.
 *
 * Returns: Zero no caso de sucesso, não-zero no caso de falha
 */
int main(int argc, char *argv[])
{
	return 0;
}