Documentaciónfichas(db, modulo)

fichas(db,modulo)\texttt{fichas}(db, modulo)

Nombre

fichas - Reune las fichas documentales de todas las funciones de un modulo.

Sinopsis

texto = docs.fichas(db, modulo)

Descripcion

Consulta la base documental y genera, en un solo bloque Markdown, las fichas de todas las funciones pertenecientes a un modulo.

Es util para:

  • recorrer una API completa
  • generar salidas de referencia por modulo
  • inspeccionar todas las funciones de una biblioteca BLOX

Comportamiento

  • El parametro modulo debe indicar la clave del modulo, por ejemplo "FISICAS" o "SQLITE".
  • Las funciones se recuperan desde la base documental y se renderizan una tras otra usando el formato de docs.ficha().
  • Si el modulo no existe o no tiene funciones documentadas, retorna una salida vacia o un bloque Markdown minimo, segun las coincidencias disponibles.

Funciones API relacionadas

  • docs.ficha()
  • docs.fichas_all()
  • docs.grupo()

Parámetros

ParámetroTipoDescripción
dbSQLITEHandle de conexion SQLite abierto sobre documentacion_blox.db.
moduloSTRINGClave del modulo a recorrer.

Valor de retorno

STRING - Markdown acumulado con todas las fichas del modulo.

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 md

    db = sqlite.abrir("documentacion_blox.db")
    md = docs.fichas(db, "FISICAS")
    sqlite.cerrar(db)
    IMPRIMIR_WEB(md)    
FINAL
← Volver al inicioDescargar Blox →