Documentacióngrupos(modulo)

grupos(modulo)\texttt{grupos}(modulo)

Nombre

grupos - Lista los grupos documentales presentes en un modulo.

Sinopsis

tabla = docs.grupos(modulo)

Descripcion

Abre la base documental y devuelve los grupos distintos registrados dentro de un modulo.

Es util para:

  • verificar familias de funciones dentro de una API
  • recorrer documentacion por bloques semanticos
  • preparar consultas posteriores con docs.grupo()

Comportamiento

  • Abre internamente documentacion_blox.db.
  • La busqueda se restringe al modulo indicado.
  • Devuelve una fila por cada grupo distinto presente en v_funciones.
  • Si el modulo no tiene grupos documentados, retorna una tabla vacia.

Funciones API relacionadas

  • docs.modulos()
  • docs.funciones()

Parámetros

ParámetroTipoDescripción
moduloSTRINGClave del modulo, por ejemplo STRINGS o SQLITE.

Valor de retorno

TABLA - TABLA con una fila por grupo distinto dentro del modulo.

Ejemplo

ejemplo.blox
INCLUIR "docs.api"

FUNCION PRINCIPAL
INICIO

    TABLA t

    t = docs.grupos("STRINGS")
    IMPRIMIR(t)

FINAL