Documentacióngrupo(modulo, grupo, opcion)
Nombre
grupo - Reune en Markdown las funciones pertenecientes a un grupo documental.
Sinopsis
texto = docs.grupo(modulo, grupo, opcion)
Descripcion
Abre la base documental y arma una salida Markdown con todas las funciones pertenecientes a un grupo de un modulo.
Es util para:
- verificar familias completas de funciones
- revisar una biblioteca por bloques semanticos
- generar salidas resumidas o completas de un grupo especifico
Comportamiento
- Abre internamente
documentacion_blox.db. - La busqueda se restringe al modulo y grupo indicados.
- Con
""devuelve fichas completas usandodocs.ficha(). - Con
"-f"devuelve una vista resumida de todas las funciones del grupo. - Si no encuentra coincidencias, retorna un mensaje Markdown indicando que no hubo resultados.
Funciones API relacionadas
docs.ficha()docs.fichas()docs.fichas_all()
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| modulo | STRING | Clave del modulo, por ejemplo STRINGS. |
| grupo | STRING | Nombre del grupo documental, por ejemplo VALIDACION o PARTES. |
| opcion | STRING | Modo de salida. "" devuelve fichas completas y "-f" devuelve una vista resumida. |
Valor de retorno
STRING - Markdown acumulado con las funciones del grupo solicitado.
Ejemplo
ejemplo.blox
INCLUIR "docs.api"
FUNCION PRINCIPAL
INICIO
STRING md
md = docs.grupo("STRINGS", "UTILIDADES", "")
IMPRIMIR_MD(md)
FINAL