Documentaciónfichas_all(db)

fichas_all(db)\texttt{fichas\_all}(db)

Nombre

fichas_all - Reune las fichas documentales de todas las funciones registradas.

Sinopsis

texto = docs.fichas_all(db)

Descripcion

Recorre todos los modulos de la base documental y acumula en un solo bloque Markdown las fichas de todas las funciones documentadas.

Es util para:

  • generar un manual general
  • inspeccionar toda la base documental
  • exportar una referencia completa del sistema

Comportamiento

  • Consulta primero la lista de modulos disponibles.
  • Luego invoca la logica de docs.fichas() para cada modulo.
  • El resultado final concatena todas las fichas en orden.

Funciones API relacionadas

  • docs.ficha()
  • docs.fichas()
  • docs.grupo()

Parámetros

ParámetroTipoDescripción
dbSQLITEHandle de conexion SQLite abierto sobre documentacion_blox.db.

Valor de retorno

STRING - Markdown acumulado con todo el manual de referencia disponible.

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_all(db)
    sqlite.cerrar(db)
    IMPRIMIR_WEB(md)  
FINAL