File size: 2,273 Bytes
7d0c16f
 
 
 
0324409
 
 
 
 
 
 
7d0c16f
0324409
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
7d0c16f
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
{% extends "base.html.j2" %}
{% import "components.html.j2" as ui %}

{% block content %}
  <header class="doc-header">
    <h1>{{ doc.metadata.script_type or "M贸dulo interno" }}{{ doc.metadata.description or "Documentaci贸n" }}</h1>
    <p class="doc-header-meta">
      M贸dulo compartido / servicios internos
    </p>
    <p class="muted">Referencia funcional del m贸dulo compartido.</p>
  </header>

  {{ ui.metadata_block(doc.metadata) }}
  {{ ui.summary_block(doc.summary) }}

  {# ------------------------ API p煤blica ------------------------ #}
  {% if doc.api %}
    <div class="section">
      <h2>API p煤blica</h2>

      {% for fn in doc.api %}
        <h3>{{ fn.name }}</h3>
        <p>{{ fn.description }}</p>

        {# Par&aacute;metros: solo tabla si hay datos estructurados #}
        {% if fn.parameters %}
          {{ ui.table_block("Par谩metros", fn.parameters, [
            {"field": "name", "title": "Nombre"},
            {"field": "description", "title": "Descripci贸n"},
            {"field": "type", "title": "Tipo"}
          ]) }}
        {% endif %}

        {% if fn.side_effects %}
          {{ ui.list_block("Efectos colaterales", fn.side_effects) }}
        {% endif %}

        {% if fn.returns %}
          {{ ui.logic_block("Retorna", fn.returns) }}
        {% endif %}
      {% endfor %}
    </div>
  {% endif %}

  {# ------------------------ Efectos generales del m贸dulo ------------------------ #}
  {% if doc.side_effects %}
    {{ ui.list_block("Efectos colaterales", doc.side_effects) }}
  {% endif %}

  {# ------------------------ Errores ------------------------ #}
  {% if doc.errors %}
    {% if doc.errors is mapping %}
      {# Si alg煤n d铆a viene como objeto: usar list_block sobre sus partes #}
      {{ ui.list_block("Errores", doc.errors.explicit_checks or []) }}
      {{ ui.list_block("Manejo de excepciones", doc.errors.exception_handling or []) }}
    {% else %}
      {# Caso actual t铆pico: lista simple de strings #}
      {{ ui.list_block("Errores", doc.errors) }}
    {% endif %}
  {% endif %}

  {# ------------------------ Detalles de implementaci贸n ------------------------ #}
  {% if doc.logic %}
    {{ ui.logic_block("Detalles de implementaci贸n", doc.logic) }}
  {% endif %}
{% endblock %}