Documentaciónman(modulo, funcion, opcion)

man(modulo,funcion,opcion)\texttt{man}(modulo, funcion, opcion)

Nombre

man - Consulta documentacion de funciones BLOX desde la base documental.

Sinopsis

texto = docs.man(modulo, funcion, opcion)

Descripcion

Busca y devuelve documentacion en formato Markdown a partir de la base documentacion_blox.db.

Permite:

  • consultar una funcion puntual
  • buscar por comodin
  • restringir la busqueda a un modulo
  • pedir una salida resumida

Comportamiento de busqueda

  • Si modulo es "" o "*", la busqueda se realiza en todos los modulos.
  • Si funcion contiene *, se interpreta como patron parcial.
  • Si funcion es "" o "*", se consideran todas las funciones.
  • Si se indica un modulo especifico, la busqueda se restringe a ese modulo.

Parámetros

ParámetroTipoDescripción
moduloSTRINGClave del modulo a restringir. Los valores "" y "*" equivalen a buscar en todos los modulos.
funcionSTRINGNombre de la funcion a buscar. Puede incluir * como comodin, por ejemplo impr* o SQLITE_*. Los valores "" y "*" equivalen a consultar todas las funciones.
opcionSTRINGModo de salida. "" devuelve fichas completas, "-f" devuelve una vista resumida y "-k" lista los modulos donde aparece la funcion.

Valor de retorno

STRING - Markdown listo para IMPRIMIR_WEB() o para cualquier otro destino de salida.

Ejemplo

ejemplo.blox
//
// Ejemplo de uso de docs.man()
//
// - ""   : ficha completa
// - "-f" : vista resumida
// - "-k" : modulos donde aparece la funcion
//

INCLUIR "docs.api"

FUNCION PRINCIPAL
INICIO

    STRING md

    md = docs.man("", "ficha", "-k")
    IMPRIMIR_WEB(md)
FINAL
← Volver al inicioDescargar Blox →