Documentaciónfuncion_info(db, modulo, funcion)
Nombre
funcion_info - Recupera la informacion base de una funcion documentada.
Sinopsis
tabla = docs.funcion_info(db, modulo, funcion)
Descripcion
Consulta la base documental y devuelve la informacion principal de una funcion dentro de un modulo.
Normalmente incluye datos como:
- modulo
- clave del modulo
- nombre de la funcion
- nombre calificado
- descripcion base
- tipo y descripcion de retorno
- metadatos adicionales, si existen
Comportamiento
- La busqueda se restringe al modulo indicado.
- Si la funcion existe, devuelve una tabla con su ficha base.
- Si no hay coincidencias, devuelve una tabla vacia.
Funciones API relacionadas
docs.funcion_argumentos()docs.funcion_ejemplos()
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| db | SQLITE | Handle de conexion SQLite abierto sobre documentacion_blox.db. |
| modulo | STRING | Clave del modulo, por ejemplo ARCHIVOS. |
| funcion | STRING | Nombre de la funcion a consultar. |
Valor de retorno
TABLA - TABLA con la informacion principal de la funcion.
Ejemplo
ejemplo.blox
TABLA resultado
resultado = docs.funcion_info(db, modulo, funcion)