summaryrefslogtreecommitdiff
path: root/tools/gendocs/exporter.py
blob: c34c4686f354276e83440cfa13b5cc9b5ca233b3 (plain)
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
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
#!/usr/bin/python3
# -*- coding: utf-8 -*-


class DocExporter:
    """Exporte une documentation d'une façon donnée."""


    def open(self, name, fullname):
        """Initialise les propriétés utiles."""

        pass


    def close(self):
        """Termine l'édition de la documentation."""

        pass


    def show_list_sub_modules(self, gparent, parent, others, builder):
        """Affiche des renvois vers les sous-parties présentes."""

        pass


    def show_list_sub_classes(self, parent, classes, builder):
        """Affiche des renvois vers les sous-parties présentes."""

        pass


    def describe_module(self, desc):
        """Affiche la description du module courant."""

        pass


    def start_main_section(self, title):
        """Affiche un en-tête pour la zone des classes."""

        pass


    def show_class_info(self, name, desc):
        """Affiche les informations générales d'une classe."""

        pass


    def show_info_section(self, title):
        """Affiche une section d'informations particulières."""

        pass


    def begin_hierarchy_level(self):
        """Démarre une arborescence hiérarchique."""

        pass


    def terminate_hierarchy_level(self):
        """Arrête une arborescence hiérarchique."""

        pass


    def print_hierarchy_level(self, fullname, name, page, level):
        """Affiche un élément hiérarchique."""

        pass


    def show_constant_info(self, name):
        """Affiche un élément de type 'constant'."""

        pass


    def show_data_info(self, name, value):
        """Affiche un élément de type 'donnée'."""

        pass

    def show_attribute_info(self, name, desc):
        """Affiche un élément de type 'attribut'."""

        pass


    def show_callable_info(self, ret, name, args, desc):
        """Affiche un élément de type 'routine'."""

        pass