Documentation de la classe PiCameraGUI

jtpaquet · Jun 7, 2018 · 1578c9b · 1578c9b
1 parent cfc122c
commit 1578c9b
Show file tree

Hide file tree

Showing 3 changed files with 29 additions and 10 deletions.
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -19,6 +19,8 @@
 autodoc_mock_imports = ["tkinter", "fractions"]
 
 
+
+
 # -- Project information -----------------------------------------------------
 
 project = u'PiCameraGUI'

diff --git a/docs/source/exceptionsmodules.rst b/docs/source/exceptionsmodules.rst
@@ -27,5 +27,10 @@ La création des deux classes sont basées sur le modèle `suivant`_. ::
         	Exception.__init__(self, mismatch)
 
 
+.. currentmodule:: PiCameraGUI
+.. autoclass:: TkinterError
+.. autoclass:: PiCameraError
+
+
 .. _Exception: https://docs.python.org/2/tutorial/errors.html
 .. _suivant: https://docs.python.org/2/tutorial/errors.html#user-defined-exceptions
diff --git a/picamera-gui/PiCameraGUI.py b/picamera-gui/PiCameraGUI.py
@@ -28,18 +28,30 @@
 
 
 
-# Classe pour l'application de la caméra
-# Fonctionnalités:
-# Aperçu en temps réel
-# Aperçu de la photo prise
-# Prise de photo, vidéo et de photos en séquence
-# Zoom et déplacement à l'intérieur de l'image en temps réel
-# Ajout de texte et du temps présent sur la photo
-# Différents formats de photo supportés
-# Rotation et revirement horizontal et vertical de l'image
-
 class PiCameraGUI(Frame):
+    """
+    Classe pour l'interface graphique de la PiCamera
+    
+    Fonctionnalités:
+    Aperçu en temps réel
+    Aperçu de la photo prise
+    Prise de photo, vidéo et de photos en séquence
+    Zoom et déplacement à l'intérieur de l'image en temps réel
+    Ajout de texte et du temps présent sur la photo
+    Différents formats de photo supportés
+    Rotation et revirement horizontal et vertical de l'image
+    
+    Arguments:
+    root: instance de Tk() ou Toplevel() de la librairie tkinter
+    
+    camera: instance de PiCamera() du module picamera
     
+    title: <string> le titre de la fenêtre
+    
+    voir le fichier main.py pour un exemple d'utilisation
+    """
+
+
     # Constructeur
     def __init__(self, root, camera, title):