Documentaciónficha(db, modulo, funcion)
Nombre
ficha - Construye la ficha documental completa de una funcion BLOX.
Sinopsis
texto = docs.ficha(db, modulo, funcion)
Descripcion
Consulta la base documental y arma una ficha completa en formato Markdown para una funcion determinada.
La ficha incluye:
- informacion general de la funcion
- descripcion enriquecida
- ejemplos relacionados, si existen
Comportamiento
- La busqueda se realiza dentro del modulo indicado.
- Si la funcion existe, devuelve una ficha lista para mostrar con
IMPRIMIR_WEB()oIMPRIMIR(). - Si no se encuentran coincidencias, retorna un mensaje Markdown indicando que no se encontro la funcion solicitada.
Funciones API relacionadas
docs.fichas()docs.fichas_all()docs.grupo()
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| db | SQLITE | Handle de conexion SQLite abierto sobre documentacion_blox.db. |
| modulo | STRING | Clave del modulo. |
| funcion | STRING | Nombre de la funcion. |
Valor de retorno
STRING - Markdown listo para IMPRIMIR_WEB() o para cualquier otro destino de salida.
Ejemplo
ejemplo.blox
//
// Nombre de la base de datos
// --------------------------
//
// - documentacion_blox.db
//
// Nombre de las tablas
// --------------------
//
// - modulos
// - funciones
// - argumentos
// - retornos
// - ejemplos
// - markdown_docs
//
// Lista de modulos
// -----------------
//
// id modulo (usar valores en mayuscula)
// ---------------------------------------
// 1 archivos 9 graficos 17 ordenar_tablas
// 2 binomiales 10 imagenes 18 poisson
// 3 docs 11 markov 19 simplex2ph
// 4 estadisticas 12 matrices 20 sqlite
// 5 fechas 13 merge 21 strings
// 6 fisicas 14 neural 22 tablas
// 7 internas 15 numericos 23 vectores
// 8 gauss 16 open_ia 24 webs
//
//
INCLUIR "sqlite.api"
INCLUIR "docs.api"
INCLUIR "tablas.api"
FUNCION PRINCIPAL
INICIO
SQLITE db
STRING resp
db = sqlite.abrir("documentacion_blox.db")
resp = docs.ficha(db, "FISICAS", "coulomb_fuerza_2d")
sqlite.cerrar(db)
IMPRIMIR_WEB(resp)
FINAL