TOC(heading=Índice)?

API de funciones

Introducción

Los desarrolladores de la interfaz de programación del proyecto deben seguir estas reglas de estilo:

• Las reglas de la API se cumplirán independientemente del lenguaje de programación utilizado.
• La documentación del código debe se r compatible con ​Doxygen.
• Debe incluirse toda la información necesaria en las cabeceras de las funciones (descripción, formato, salidas, notas, etc.).
• Deben incluirse comentarios descriptivos en los bloques de código.
• Las funciones devolverán un código de salida al estilo Unix, que indique si se ha ejecutado correctamente o se ha producido alguno de los tipos de errores definidos. En caso de error, también mostrará el mensaje correspondiente.
• Todos los nombres de funciones y variables deben estar escritos en inglés, deben ser descriptivos y fáciles de recordar.
• Nombres de funciones al estilo Rembo-C (sólo con las iniciales en mayúsculas), pero sin copiarlos de Rembo-C. Según se estime oportuno, los nombres de funciones podrán tener un prefijo indicativo del proyecto o del componente del proyecto al que pertenece.
• Las constantes y variables globales deben ir escritas en mayúsculas.

Parámetros

(cómo serán los parámetros de las funciones, descripción de particiones, repositorios, ficheros, etc.)

Errores y mensajes

(códigos de error y mensajes de salida)

Funciones del motor de clonación

(lista de funciones para clonar "a mano" o desde scripts)

Funciones del gestor web

(lista de funciones ejecutadas por el gestor web)