Documentaciónmodulos(db)

modulos(db)\texttt{modulos}(db)

Nombre

modulos - Lista los modulos documentados disponibles en la base documental.

Sinopsis

tabla = docs.modulos(db)

Descripcion

Consulta la base documental y devuelve la lista de modulos disponibles para exploracion.

Es util para:

  • conocer que APIs estan registradas
  • recorrer la documentacion por modulo
  • construir menus o indices de navegacion

Comportamiento

  • Lee la tabla de modulos de la base documental.
  • Devuelve los modulos ordenados para su consulta posterior.
  • Cada registro representa un modulo documentado dentro del sistema.

Funciones API relacionadas

  • docs.funciones()
  • docs.grupos()

Parámetros

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

Valor de retorno

TABLA - TABLA con los campos id, nombre, clave y archivo_json.

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  modulos

    db = sqlite.abrir("documentacion_blox.db")
      modulos = docs.modulos(db)
      tablas.imprimir(modulos)
    sqlite.cerrar(db)

FINAL