Documentación en línea del programa
Puede documentar programas y su interfaz de línea de comandos usando la documentación en línea.
Etiquetas
- PROGRAM
-
Define el inicio de la documentación de un programa.
- @short_description:
-
Define una descripción corta del programa. (Opcional)
- @synopsis:
-
Define el argumento o la lista de argumentos que el programa puede usar. (Opcional)
- @see_also:
-
Página del manual Ver también. (Opcional)
- @arg:
-
Argumentos pasados al programa y su descripción. (Opcional)
- Description:
-
Una descripción más larga del programa.
- Devuelve:
-
Especifique qué valores devuelve el programa. (Opcional)
3.4.1. Ejemplo de documentación de un programa.
Ejemplo 3-12 Bloque de documentación del programa
/** * PROGRAM:test-program * @short_description: A test program * @synopsis: test-program [*OPTIONS*...] --arg1 *arg* *FILE* * @see_also: test(1) * @--arg1 *arg*: set arg1 to *arg* * @--arg2 *arg*: set arg2 to *arg* * @-v, --version: Print the version number * @-h, --help: Print the help message * * Long description of program. * * Returns: Zero on success, non-zero on failure */ int main(int argc, char *argv[]) { return 0; }