Typos in doc

src/Mara/Gui/ControlDialogWindow.hpp

@@ -29,7 +29,7 @@ class InformationTab : public QWidget
     ~InformationTab() override                    = default;
     /**@}*/
 
-    /// Diaply the information about the file
+    /// Display the information about the file
     void setFileInfo( const QString& fileName,
                       const std::tuple<size_t, size_t, size_t>& sceneStats );
 

src/Mara/Gui/RendererControl.hpp

@@ -14,8 +14,17 @@ namespace Mara {
  *
  * Allow to switch from a renderer to the other and to select renderer outputs (textures).
  *
- * When a renderer is activated, this control is filld by the renderer specific control panel in
+ * When a renderer is activated, this control is filled by the renderer specific control panel in
  * addition of the renderer common controlers.
+ *
+ * This gui presents the following interaction elements
+ *  - Renderers combo box : filled by the set of rmanaged renderers, this combo box allow to
+ *      switch from one renderer to another.
+ *  - Camera buttons : two button, independant from the renderer, that allow to manage the active
+ *      camera.
+ *  - Renderer specific control : This control contains two things :
+ *      - for any renderer, a combox to select the displayed AOV produced by the renderer.
+ *      - A control panel specific to the active renderer to manage its internal state
  */
 class RendererControl : public QFrame, private Ui::RendererControler
 {
@@ -38,7 +47,8 @@ class RendererControl : public QFrame, private Ui::RendererControler
      * Add a renderer to the control panel
      * @param rendererName The name that will appear in the renderer selection combobox.
      * @param renderer A pointer to the renderer to add. The ownership is left to the caller.
-     * @param callback The function to call when a renderer is activated.
+     * @param callback The function to call to activate a renderer. Must return true if the
+     * activation succeed.
      * @param controlPanel The renderer specific control gui.
      */
     void addRenderer( const std::string& rendererName,
@@ -50,7 +60,9 @@ class RendererControl : public QFrame, private Ui::RendererControler
     /// Signal emitted when an internal state of the active renderer  was changed.
     void rendererStateChanged();
 
+    /// Signal emitted when the "fit camera" button is pressed
     void fitCamera();
+    /// Signal emitted when the "Reset camera" is pressed
     void resetCamera();
 
   private slots:
@@ -61,7 +73,7 @@ class RendererControl : public QFrame, private Ui::RendererControler
     void changeTexture( const std::string& texture );
 
   private:
-    /// The association between a renderer and its callback
+    /// The association between a renderer and its activation function
     using RendererInfo = std::pair<Ra::Engine::Renderer* const, std::function<bool()>>;
     /// The active renderer
     int m_currentRenderer{ -1 };