Documentaciónfunciones(db, modulo)

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

Nombre

funciones - Lista las funciones documentadas de un modulo.

Sinopsis

tabla = docs.funciones(db, modulo)

Descripcion

Consulta la base documental y devuelve la lista de funciones registradas para un modulo determinado.

Es util para:

  • explorar una API concreta
  • construir menus o indices por modulo
  • obtener un resumen rapido antes de consultar fichas completas

Comportamiento

  • El parametro modulo debe ser la clave del modulo, por ejemplo "ARCHIVOS" o "SQLITE".
  • Devuelve una tabla con una fila por funcion documentada.
  • Si el modulo no existe o no tiene funciones, retorna una tabla vacia.

Funciones API relacionadas

  • docs.modulos()
  • docs.grupos()

Parámetros

ParámetroTipoDescripción
dbSQLITEHandle de conexion SQLite abierto sobre documentacion_blox.db.
moduloSTRINGClave del modulo, por ejemplo ARCHIVOS o SQLITE.

Valor de retorno

TABLA - TABLA con nombre y retorno_tipo.

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
    TABLA  funciones

    db = sqlite.abrir("documentacion_blox.db")
      funciones = docs.funciones(db, "FISICAS")
      tablas.imprimir(funciones)
    sqlite.cerrar(db)

FINAL