autodocumentation de la classe PiCameraGUI

jtpaquet · Jun 8, 2018 · 2e6d73c · 2e6d73c
1 parent a2fabdc
commit 2e6d73c
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 15 deletions.
diff --git a/docs/source/code.rst b/docs/source/code.rst
@@ -39,6 +39,7 @@ Ce fichier contient la classe ``PiCameraGUI`` qui s'occupe de la création de l'
 
 .. currentmodule:: PiCameraGUI
 .. autoclass:: PiCameraGUI
+     :members:
 
 
 .. _layout:

diff --git a/docs/source/userguide.rst b/docs/source/userguide.rst
@@ -154,8 +154,6 @@ affiché juste au-dessous de la boîte.
 Modification de la sauvegarde
 =============================
 
-* Format
-
 Vous pouvez changer le format du fichier en appuyant sur les flèches de la ``spinbox`` dans la section ``Sauvegarde``. Les formats disponibles sont
 
 	- ``'jpeg'`` - Encodage JPEG
@@ -165,18 +163,12 @@ Vous pouvez changer le format du fichier en appuyant sur les flèches de la ``sp
         - ``'rgb'`` - Données images brutes en format 24-bit RGB
         - ``'rgba'`` - Données images brutes en format 32-bit RGBA
 
-* Nom du fichier
-
 Vous pouvez modifier le nom du fichier de la capture en écrivant dans la boîte ``Nom du fichier``. Notez que le temps est ajouté suite au nom que vous aurez donné au fichier pour 
 empêcher d'enregistrer une capture par-dessus une capture déjà existante. Appuyez sur le bouton ``Confirmer`` pour valider votre choix.
 
-* Changer de répertoire
-
 Si vous souhaitez enregistrer vos captures dans un autre répertoire vous pouvez commencer par ouvrir le 
 menu **Fichier** et choisir un nouveau répertoire. Par défaut, le répertoire pour les photos est ``Capture/`` et celui des vidéos est ``Vidéo/``
 
-* Aperçus
-
 Si vous n'êtes pas sûr de l'endroit de la sauvegarde ou du nom de fichier, vous pouvez voir un aperçu sous le bouton ``Confirmer``
 
 .. _other:

diff --git a/picamera-gui/PiCameraGUI.py b/picamera-gui/PiCameraGUI.py
@@ -33,7 +33,9 @@ class PiCameraGUI(Frame):
     """
     Classe pour l'interface graphique de la PiCamera
     
-    Fonctionnalités:
+    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
@@ -42,14 +44,19 @@ class PiCameraGUI(Frame):
     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
+    Arguments
+    =========
+
+    :param root: Fenêtre principal issue de la librairie ``tkinter``
+    :type  root: Tk() ou Toplevel()
     
-    title: <string> le titre de la fenêtre
+    :param camera: Objet caméra issu du module ``picamera``
+    :type  camera: PiCamera()
+
+    :param title: Titre de la fenêtre
+    :type  title: String
     
-    voir le fichier main.py pour un exemple d'utilisation
+    Voir le fichier ``main.py`` pour un exemple d'utilisation
     """