From b258bc9275a0a91bc8bd0ce7ea29fdaac4a4db8c Mon Sep 17 00:00:00 2001 From: Ichthyostega Date: Sun, 6 Nov 2016 14:19:14 +0100 Subject: [PATCH] Doxygen: fill in missing file level headlines for the GUI --- src/common/guifacade.cpp | 7 ++++++- src/gui/ctrl/playback-controller.cpp | 5 ++++- src/gui/dialog/dialog.hpp | 2 +- src/gui/dialog/name-chooser.cpp | 3 ++- src/gui/dialog/name-chooser.hpp | 2 +- src/gui/dialog/preferences-dialog.hpp | 5 ++++- src/gui/dialog/render.cpp | 3 ++- src/gui/dialog/render.hpp | 2 +- src/gui/guifacade.hpp | 2 +- src/gui/model/clip-track.cpp | 4 +++- src/gui/model/clip-track.hpp | 7 ++++--- src/gui/model/clip.cpp | 5 ++++- src/gui/model/clip.hpp | 4 +++- src/gui/model/group-track.cpp | 5 ++++- src/gui/model/group-track.hpp | 6 +++++- src/gui/model/parent-track.cpp | 5 ++++- src/gui/model/parent-track.hpp | 11 +++++++---- src/gui/model/project.cpp | 6 +++++- src/gui/model/project.hpp | 4 +++- src/gui/model/sequence.cpp | 4 +++- src/gui/model/sequence.hpp | 10 ++++++---- src/gui/model/track.cpp | 5 ++++- src/gui/model/track.hpp | 5 ++++- src/gui/output/displayer.cpp | 9 ++++++++- src/gui/output/displayer.hpp | 6 +++++- src/gui/output/gdkdisplayer.cpp | 4 +++- src/gui/output/xvdisplayer.cpp | 7 ++++++- src/gui/output/xvdisplayer.hpp | 6 +++++- src/gui/panel/assets-panel.cpp | 2 +- src/gui/panel/assets-panel.hpp | 8 +++++++- src/gui/panel/panel.cpp | 2 +- src/gui/panel/panel.hpp | 2 +- src/gui/panel/timeline-panel.cpp | 2 +- src/gui/panel/viewer-panel.cpp | 2 +- src/gui/panel/viewer-panel.hpp | 2 +- src/gui/util/cairo-util.cpp | 2 +- src/gui/util/cairo-util.hpp | 3 ++- src/gui/util/rectangle.cpp | 2 +- src/gui/util/rectangle.hpp | 2 +- src/gui/widget/timeline/basic-draw-strategy.hpp | 2 +- src/gui/widget/timeline/draw-strategy.cpp | 3 ++- src/gui/widget/timeline/draw-strategy.hpp | 5 ++++- src/gui/widget/timeline/timeline-arrow-tool.cpp | 2 +- src/gui/widget/timeline/timeline-arrow-tool.hpp | 1 + src/gui/widget/timeline/timeline-body.cpp | 2 +- src/gui/widget/timeline/timeline-body.hpp | 1 + src/gui/widget/timeline/timeline-clip-track.cpp | 2 +- src/gui/widget/timeline/timeline-clip.cpp | 2 +- src/gui/widget/timeline/timeline-clip.hpp | 1 + src/gui/widget/timeline/timeline-entity.cpp | 3 ++- src/gui/widget/timeline/timeline-entity.hpp | 3 ++- src/gui/widget/timeline/timeline-group-track.cpp | 3 ++- src/gui/widget/timeline/timeline-group-track.hpp | 4 +++- src/gui/widget/timeline/timeline-header-container.cpp | 2 +- src/gui/widget/timeline/timeline-header-container.hpp | 5 ++++- src/gui/widget/timeline/timeline-header-widget.cpp | 2 +- src/gui/widget/timeline/timeline-header-widget.hpp | 3 ++- src/gui/widget/timeline/timeline-ibeam-tool.cpp | 2 +- src/gui/widget/timeline/timeline-ibeam-tool.hpp | 1 + src/gui/widget/timeline/timeline-layout-helper.cpp | 3 ++- src/gui/widget/timeline/timeline-layout-helper.hpp | 3 ++- src/gui/widget/timeline/timeline-ruler.cpp | 3 ++- src/gui/widget/timeline/timeline-ruler.hpp | 3 ++- src/gui/widget/timeline/timeline-state.cpp | 3 ++- src/gui/widget/timeline/timeline-state.hpp | 4 +++- src/gui/widget/timeline/timeline-tool.cpp | 3 ++- src/gui/widget/timeline/timeline-tool.hpp | 4 +++- src/gui/widget/timeline/timeline-track.cpp | 4 +++- src/gui/widget/timeline/timeline-track.hpp | 4 +++- src/gui/widget/timeline/timeline-view-window.cpp | 3 ++- src/gui/widget/timeline/timeline-view-window.hpp | 3 ++- src/gui/widget/timeline/timeline-zoom-scale.cpp | 3 ++- src/gui/widget/timeline/timeline-zoom-scale.hpp | 3 ++- 73 files changed, 191 insertions(+), 77 deletions(-) diff --git a/src/common/guifacade.cpp b/src/common/guifacade.cpp index 1f5598c7b..4c4afc6ac 100644 --- a/src/common/guifacade.cpp +++ b/src/common/guifacade.cpp @@ -22,7 +22,12 @@ /** @file guifacade.cpp - ** TODO guifacade.cpp + ** Implementation of the GUI loader. Code generated from this + ** translation unit is linked into the core application, where it implements + ** the [Subsystem descriptor](subsys.hpp) for the _UI Subsystem._ When main() + ** activates and starts this subsystem, an instance of gui::GuiRunner will be + ** created, which causes the Lumiera UI plug-in to be loaded and a new thread + ** to be spawned, which launches the UI and performs the event loop. */ diff --git a/src/gui/ctrl/playback-controller.cpp b/src/gui/ctrl/playback-controller.cpp index 40565a640..c9ba61226 100644 --- a/src/gui/ctrl/playback-controller.cpp +++ b/src/gui/ctrl/playback-controller.cpp @@ -22,7 +22,10 @@ /** @file playback-controller.cpp - ** TODO playback-controller.cpp + ** Implementation parts of PlaybackController. + ** @warning this is preliminary code and will be reworked, once + ** we're able to connect to actual playback processes + ** performed by the render engine. */ diff --git a/src/gui/dialog/dialog.hpp b/src/gui/dialog/dialog.hpp index 89d3c8d1a..4137c167d 100644 --- a/src/gui/dialog/dialog.hpp +++ b/src/gui/dialog/dialog.hpp @@ -22,7 +22,7 @@ /** @file dialog.hpp - ** TODO dialog.hpp + ** Global constants and definitions for dialogs. */ diff --git a/src/gui/dialog/name-chooser.cpp b/src/gui/dialog/name-chooser.cpp index 8fb9d2556..b1015a93e 100644 --- a/src/gui/dialog/name-chooser.cpp +++ b/src/gui/dialog/name-chooser.cpp @@ -22,7 +22,8 @@ /** @file name-chooser.cpp - ** TODO name-chooser.cpp + ** Implementation details of NameChooser, + ** a dialog to enter a name string. */ diff --git a/src/gui/dialog/name-chooser.hpp b/src/gui/dialog/name-chooser.hpp index bbba4a9eb..efb98e5ee 100644 --- a/src/gui/dialog/name-chooser.hpp +++ b/src/gui/dialog/name-chooser.hpp @@ -22,7 +22,7 @@ /** @file name-chooser.hpp - ** TODO name-chooser.hpp + ** Dialog to enter a string name. */ diff --git a/src/gui/dialog/preferences-dialog.hpp b/src/gui/dialog/preferences-dialog.hpp index 6dc45af36..8a859935f 100644 --- a/src/gui/dialog/preferences-dialog.hpp +++ b/src/gui/dialog/preferences-dialog.hpp @@ -22,7 +22,10 @@ /** @file preferences-dialog.hpp - ** TODO preferences-dialog.hpp + ** Dialog to manage application preferences. + ** @todo as of 2016, this is more of a place-holder, since we also + ** do not have decided on the implementation approach for + ** application preferences in general. */ diff --git a/src/gui/dialog/render.cpp b/src/gui/dialog/render.cpp index 227f82ab2..eb81f6d3e 100644 --- a/src/gui/dialog/render.cpp +++ b/src/gui/dialog/render.cpp @@ -22,7 +22,8 @@ /** @file render.cpp - ** TODO render.cpp + ** Implementation of gui:dialog::Render, which is a Dialog + ** to set up a renter process and define output name and format. */ diff --git a/src/gui/dialog/render.hpp b/src/gui/dialog/render.hpp index 5f105b31c..e35d71851 100644 --- a/src/gui/dialog/render.hpp +++ b/src/gui/dialog/render.hpp @@ -21,7 +21,7 @@ */ /** @file render.hpp - ** definition of the render output dialog + ** Dialog to set up a renter process and define output name and format. ** */ diff --git a/src/gui/guifacade.hpp b/src/gui/guifacade.hpp index 5c8b5a31c..e05e5bdc6 100644 --- a/src/gui/guifacade.hpp +++ b/src/gui/guifacade.hpp @@ -25,7 +25,7 @@ ** lower layers of Lumiera. While part of the public interface of the Lumiera GUI, ** the implementation of this facility is part of the core application (and not ** contained within the GUI dynamic module), because it's job is to load and - ** activate this module and to startup the GUI. + ** activate this module as plug-in and to startup the GUI. ** ** @see lumiera::AppState ** @see lumiera::Option diff --git a/src/gui/model/clip-track.cpp b/src/gui/model/clip-track.cpp index dd4bdf086..007522d98 100644 --- a/src/gui/model/clip-track.cpp +++ b/src/gui/model/clip-track.cpp @@ -22,7 +22,9 @@ /** @file clip-track.cpp - ** TODO clip-track.cpp + ** Preliminary UI-model: Implementation of timeline track model object. + ** @warning as of 2016 this UI model is known to be a temporary workaround + ** and will be replaced in entirety by UI-Bus and diff framework. */ #include "clip-track.hpp" diff --git a/src/gui/model/clip-track.hpp b/src/gui/model/clip-track.hpp index 24169a04e..15ac37d47 100644 --- a/src/gui/model/clip-track.hpp +++ b/src/gui/model/clip-track.hpp @@ -21,9 +21,10 @@ */ /** - * @file model/clip-track.hpp - * This file contains the definition of timeline track objects which - * contain clips. + ** @file model/clip-track.hpp + ** Preliminary UI-model: Definition of timeline track objects which contain clips. + ** @warning as of 2016 this UI model is known to be a temporary workaround + ** and will be replaced in entirety by UI-Bus and diff framework. */ diff --git a/src/gui/model/clip.cpp b/src/gui/model/clip.cpp index 59c2fd21f..ee6dead8d 100644 --- a/src/gui/model/clip.cpp +++ b/src/gui/model/clip.cpp @@ -22,7 +22,10 @@ /** @file clip.cpp - ** TODO clip.cpp + ** Preliminary UI-model: implementation of a Clip object as placeholder to + ** base the GUI implementation on. + ** @warning as of 2016 this UI model is known to be a temporary workaround + ** and will be replaced in entirety by UI-Bus and diff framework. */ diff --git a/src/gui/model/clip.hpp b/src/gui/model/clip.hpp index 134680e95..71cd15f2f 100644 --- a/src/gui/model/clip.hpp +++ b/src/gui/model/clip.hpp @@ -21,8 +21,10 @@ */ /** @file model/clip.hpp - ** This file defines a Proxy Clip object to base the GUI implementation on. + ** Preliminary UI-model: a Proxy Clip object to base the GUI implementation on. ** Later this Clip object will be connected to the underlying model in Proc-Layer. + ** @warning as of 2016 this UI model is known to be a temporary workaround + ** and will be replaced in entirety by UI-Bus and diff framework. */ #ifndef GUI_MODEL_CLIP_H diff --git a/src/gui/model/group-track.cpp b/src/gui/model/group-track.cpp index b27e6e6e2..f5fb8415c 100644 --- a/src/gui/model/group-track.cpp +++ b/src/gui/model/group-track.cpp @@ -22,7 +22,10 @@ /** @file group-track.cpp - ** TODO group-track.cpp + ** Preliminary UI-model: Implementation for the group track timeline objects. + ** @warning as of 2016 this UI model is known to be a temporary workaround + ** and will be replaced in entirety by UI-Bus and diff framework. + ** @deprecated the existing timeline implementation will be completely rewritten */ #include "group-track.hpp" diff --git a/src/gui/model/group-track.hpp b/src/gui/model/group-track.hpp index 77ccc9a5e..11185a571 100644 --- a/src/gui/model/group-track.hpp +++ b/src/gui/model/group-track.hpp @@ -21,7 +21,10 @@ */ /** @file widget/timeline/group-track.hpp - ** This file contains the definition of group track timeline objects + ** Preliminary UI-model: Definition of group track timeline objects. + ** @warning as of 2016 this UI model is known to be a temporary workaround + ** and will be replaced in entirety by UI-Bus and diff framework. + ** @deprecated the existing timeline implementation will be completely rewritten */ @@ -36,6 +39,7 @@ namespace model { /** * A class representation of a grouping of tracks. + * @deprecated the existing timeline implementation will be rewritten */ class GroupTrack : public ParentTrack { diff --git a/src/gui/model/parent-track.cpp b/src/gui/model/parent-track.cpp index 2326c96aa..3a7d7c5f2 100644 --- a/src/gui/model/parent-track.cpp +++ b/src/gui/model/parent-track.cpp @@ -22,7 +22,10 @@ /** @file parent-track.cpp - ** TODO parent-track.cpp + ** Preliminary UI-model: Implementation of ParentTrack. + ** @warning as of 2016 this UI model is known to be a temporary workaround + ** and will be replaced in entirety by UI-Bus and diff framework. + ** @deprecated the existing timeline implementation will be completely rewritten */ #include "parent-track.hpp" diff --git a/src/gui/model/parent-track.hpp b/src/gui/model/parent-track.hpp index 12053e321..11610fb48 100644 --- a/src/gui/model/parent-track.hpp +++ b/src/gui/model/parent-track.hpp @@ -20,9 +20,12 @@ */ /** @file parent-track.hpp - ** This file contains the definition of ParentTrack, a class which + ** Preliminary UI-model: Definition of ParentTrack, a class which ** represents a base functionality for tracks and sequences which - ** are also track parents. This class wraps proc layer data + ** are also track parents. This class was intended to wraps proc layer data. + ** @warning as of 2016 this UI model is known to be a temporary workaround + ** and will be replaced in entirety by UI-Bus and diff framework. + ** @deprecated the existing timeline implementation will be completely rewritten */ #ifndef PARENT_TRACK_HPP @@ -35,8 +38,8 @@ namespace gui { namespace model { /** - * ParentTrack is the abstract base class of all tracks that can parent - * children. + * ParentTrack is the abstract base class of all tracks that can parent children. + * @deprecated the existing timeline implementation will be rewritten */ class ParentTrack : public Track, diff --git a/src/gui/model/project.cpp b/src/gui/model/project.cpp index cbe77efcb..d33f02247 100644 --- a/src/gui/model/project.cpp +++ b/src/gui/model/project.cpp @@ -22,7 +22,11 @@ /** @file project.cpp - ** TODO project.cpp + ** Preliminary UI-model: Implementation of Project, a class which + ** stores project data, and wraps proc layer data. + ** @warning as of 2016 this UI model is known to be a temporary workaround + ** and will be replaced in entirety by UI-Bus and diff framework. + ** */ diff --git a/src/gui/model/project.hpp b/src/gui/model/project.hpp index 363c73544..466986aac 100644 --- a/src/gui/model/project.hpp +++ b/src/gui/model/project.hpp @@ -21,8 +21,10 @@ */ /** @file project.hpp - ** This file contains the definition of Project, a class which + ** Preliminary UI-model: Definition of Project, a class which ** stores project data, and wraps proc layer data. + ** @warning as of 2016 this UI model is known to be a temporary workaround + ** and will be replaced in entirety by UI-Bus and diff framework. ** ** @todo this solution was used to build the first outline of the UI. ** It needs to be reshaped into a connector to Proc-Layer ///////////////TICKET #959 diff --git a/src/gui/model/sequence.cpp b/src/gui/model/sequence.cpp index f66be26c5..37ba5c46e 100644 --- a/src/gui/model/sequence.cpp +++ b/src/gui/model/sequence.cpp @@ -22,7 +22,9 @@ /** @file sequence.cpp - ** TODO sequence.cpp + ** Preliminary UI-model: implementation of an editable sequence. + ** @warning as of 2016 this UI model is known to be a temporary workaround + ** and will be replaced in entirety by UI-Bus and diff framework. */ #include "gui/model/sequence.hpp" diff --git a/src/gui/model/sequence.hpp b/src/gui/model/sequence.hpp index aae7873ab..e43209340 100644 --- a/src/gui/model/sequence.hpp +++ b/src/gui/model/sequence.hpp @@ -21,10 +21,12 @@ */ /** @file sequence.hpp - ** The GUI-Model representation of an editable sequence. - ** @todo Currently (1/2014) this is a dummy placeholder, but later on - ** the GUI-Model entities will be connected to the Session model - ** through the use of PlacementRef + ** Preliminary UI-model: representation of an editable sequence. + ** @warning as of 2016 this UI model is known to be a temporary workaround + ** and will be replaced in entirety by UI-Bus and diff framework. + ** + ** @todo Currently (1/2014) this is a dummy placeholder, intention is + ** to connect GUI-Model entities to the Session model eventually. */ diff --git a/src/gui/model/track.cpp b/src/gui/model/track.cpp index d493a0039..ed3190134 100644 --- a/src/gui/model/track.cpp +++ b/src/gui/model/track.cpp @@ -22,7 +22,10 @@ /** @file track.cpp - ** TODO track.cpp + ** Preliminary UI-model: Implementation for the track timeline objects. + ** @warning as of 2016 this UI model is known to be a temporary workaround + ** and will be replaced in entirety by UI-Bus and diff framework. + ** @deprecated the existing timeline implementation will be completely rewritten */ diff --git a/src/gui/model/track.hpp b/src/gui/model/track.hpp index ebe71dab0..62281225c 100644 --- a/src/gui/model/track.hpp +++ b/src/gui/model/track.hpp @@ -20,8 +20,11 @@ */ /** @file track.hpp - ** This file contains the definition of Track, a class which + ** Preliminary UI-model: Definition of Track, a class which ** represents a track, and wraps proc layer data + ** @warning as of 2016 this UI model is known to be a temporary workaround + ** and will be replaced in entirety by UI-Bus and diff framework. + ** @deprecated the existing timeline implementation will be completely rewritten */ diff --git a/src/gui/output/displayer.cpp b/src/gui/output/displayer.cpp index 551fd35f3..d773762bb 100644 --- a/src/gui/output/displayer.cpp +++ b/src/gui/output/displayer.cpp @@ -24,7 +24,14 @@ /** @file displayer.cpp - ** TODO displayer.cpp + ** Implementation of a displayer object, intended for creating + ** a video display in the UI. This class was created as part of + ** an initial draft of the user interface. + ** @warning as of 2016 it is not clear, if this code will be + ** evolved into the actual display facility, or be + ** replaced and rewritten, when we're about to + ** create a functional video display connected + ** to the render engine. */ diff --git a/src/gui/output/displayer.hpp b/src/gui/output/displayer.hpp index 157dc4151..6f02d395c 100644 --- a/src/gui/output/displayer.hpp +++ b/src/gui/output/displayer.hpp @@ -24,7 +24,11 @@ /** @file displayer.hpp ** The Displayer serves as base of all video display implementations - ** + ** @warning as of 2016 it is not clear, if this code will be + ** evolved into the actual display facility, or be + ** replaced and rewritten, when we're about to + ** create a functional video display connected + ** to the render engine. */ diff --git a/src/gui/output/gdkdisplayer.cpp b/src/gui/output/gdkdisplayer.cpp index c088c602f..f27d6f527 100644 --- a/src/gui/output/gdkdisplayer.cpp +++ b/src/gui/output/gdkdisplayer.cpp @@ -24,7 +24,9 @@ /** @file gdkdisplayer.cpp - ** TODO gdkdisplayer.cpp + ** Dysfunctional implementation code, formerly used to + ** create a video display based on GDK + ** @deprecated obsolete since GTK-3 */ diff --git a/src/gui/output/xvdisplayer.cpp b/src/gui/output/xvdisplayer.cpp index 583330c41..b76dc9755 100644 --- a/src/gui/output/xvdisplayer.cpp +++ b/src/gui/output/xvdisplayer.cpp @@ -24,7 +24,12 @@ /** @file xvdisplayer.cpp - ** TODO xvdisplayer.cpp + ** Implementation of video output via XVideo + ** @warning as of 2016 it is not clear, if this code will be + ** evolved into the actual display facility, or be + ** replaced and rewritten, when we're about to + ** create a functional video display connected + ** to the render engine. */ diff --git a/src/gui/output/xvdisplayer.hpp b/src/gui/output/xvdisplayer.hpp index 8e87b4438..3b7af42d8 100644 --- a/src/gui/output/xvdisplayer.hpp +++ b/src/gui/output/xvdisplayer.hpp @@ -25,7 +25,11 @@ /** @file xvdisplayer.hpp ** Implementation of video output via XVideo - ** + ** @warning as of 2016 it is not clear, if this code will be + ** evolved into the actual display facility, or be + ** replaced and rewritten, when we're about to + ** create a functional video display connected + ** to the render engine. ** @see displayer.hpp */ diff --git a/src/gui/panel/assets-panel.cpp b/src/gui/panel/assets-panel.cpp index 1bc90b833..dc363d5d7 100644 --- a/src/gui/panel/assets-panel.cpp +++ b/src/gui/panel/assets-panel.cpp @@ -22,7 +22,7 @@ /** @file assets-panel.cpp - ** TODO assets-panel.cpp + ** Implementation of a (dockable) panel to organise the assets of a project. */ #include "gui/gtk-lumiera.hpp" diff --git a/src/gui/panel/assets-panel.hpp b/src/gui/panel/assets-panel.hpp index 6e0d9945d..9e7afa2d1 100644 --- a/src/gui/panel/assets-panel.hpp +++ b/src/gui/panel/assets-panel.hpp @@ -22,7 +22,13 @@ /** @file assets-panel.hpp - ** TODO assets-panel.hpp + ** A (dockable) panel to organise the assets of a project. + ** Assets are descriptor objects maintained within the Session model. + ** They are used to represent + ** - media and clips + ** - processors, effects etc. + ** - structural elements like timeline, tracks, sequences etc. + ** - metadata descriptors */ diff --git a/src/gui/panel/panel.cpp b/src/gui/panel/panel.cpp index 766e55129..36e3bcc1d 100644 --- a/src/gui/panel/panel.cpp +++ b/src/gui/panel/panel.cpp @@ -22,7 +22,7 @@ /** @file panel.cpp - ** TODO panel.cpp + ** Implementation base for all dockable panels */ diff --git a/src/gui/panel/panel.hpp b/src/gui/panel/panel.hpp index d059c526a..8e8c43509 100644 --- a/src/gui/panel/panel.hpp +++ b/src/gui/panel/panel.hpp @@ -22,7 +22,7 @@ /** @file panel.hpp - ** TODO panel.hpp + ** Base class and interface for all dockable panels */ diff --git a/src/gui/panel/timeline-panel.cpp b/src/gui/panel/timeline-panel.cpp index d7659ad92..97cfb6198 100644 --- a/src/gui/panel/timeline-panel.cpp +++ b/src/gui/panel/timeline-panel.cpp @@ -22,7 +22,7 @@ /** @file timeline-panel.cpp - ** TODO timeline-panel.cpp + ** Implementation of the dockable panel to hold the main timeline display. */ diff --git a/src/gui/panel/viewer-panel.cpp b/src/gui/panel/viewer-panel.cpp index a7dad5ccb..d288483b5 100644 --- a/src/gui/panel/viewer-panel.cpp +++ b/src/gui/panel/viewer-panel.cpp @@ -22,7 +22,7 @@ /** @file viewer-panel.cpp - ** TODO viewer-panel.cpp + ** Implementation of a dockable panel to hold the video viewers */ #include "gui/gtk-lumiera.hpp" diff --git a/src/gui/panel/viewer-panel.hpp b/src/gui/panel/viewer-panel.hpp index 3eed3d0f9..39d002911 100644 --- a/src/gui/panel/viewer-panel.hpp +++ b/src/gui/panel/viewer-panel.hpp @@ -21,7 +21,7 @@ */ /** @file viewer-panel.hpp - ** This file contains the definition of the viewer panel + ** Definition of a dockable panel to hold the video viewers */ diff --git a/src/gui/util/cairo-util.cpp b/src/gui/util/cairo-util.cpp index 936c2dec8..4165c6317 100644 --- a/src/gui/util/cairo-util.cpp +++ b/src/gui/util/cairo-util.cpp @@ -22,7 +22,7 @@ /** @file cairo-util.cpp - ** TODO cairo-util.cpp + ** Implementation of helper functions to support working with lib Cairo */ diff --git a/src/gui/util/cairo-util.hpp b/src/gui/util/cairo-util.hpp index a9702a942..788c5bc06 100644 --- a/src/gui/util/cairo-util.hpp +++ b/src/gui/util/cairo-util.hpp @@ -22,7 +22,8 @@ /** @file cairo-util.hpp - ** TODO cairo-util.hpp + ** Utility functions for working with elements from the Cairo + ** vector drawing library. */ #include diff --git a/src/gui/util/rectangle.cpp b/src/gui/util/rectangle.cpp index e5b0d4ca6..9a1dfcf0f 100644 --- a/src/gui/util/rectangle.cpp +++ b/src/gui/util/rectangle.cpp @@ -22,7 +22,7 @@ /** @file rectangle.cpp - ** TODO rectangle.cpp + ** Implementation of functions to work with rectangular screen ranges */ #include "gui/util/rectangle.hpp" diff --git a/src/gui/util/rectangle.hpp b/src/gui/util/rectangle.hpp index 29b0e79e9..3fd168612 100644 --- a/src/gui/util/rectangle.hpp +++ b/src/gui/util/rectangle.hpp @@ -22,7 +22,7 @@ /** @file rectangle.hpp - ** TODO rectangle.hpp + ** Helper functions to work with rectangular screen ranges */ diff --git a/src/gui/widget/timeline/basic-draw-strategy.hpp b/src/gui/widget/timeline/basic-draw-strategy.hpp index 58ef4f185..571cf1b26 100644 --- a/src/gui/widget/timeline/basic-draw-strategy.hpp +++ b/src/gui/widget/timeline/basic-draw-strategy.hpp @@ -22,7 +22,7 @@ /** @file basic-draw-strategy.hpp - ** TODO basic-draw-strategy.hpp + ** @warning as of 2016 the entire timeline display is planned to be reworked */ diff --git a/src/gui/widget/timeline/draw-strategy.cpp b/src/gui/widget/timeline/draw-strategy.cpp index 8932520d0..b0730989c 100644 --- a/src/gui/widget/timeline/draw-strategy.cpp +++ b/src/gui/widget/timeline/draw-strategy.cpp @@ -22,7 +22,8 @@ /** @file draw-strategy.cpp - ** TODO draw-strategy.cpp + ** @deprecated very likely to be completely rewritten. + ** @warning as of 2016 the entire timeline display is planned to be reworked */ diff --git a/src/gui/widget/timeline/draw-strategy.hpp b/src/gui/widget/timeline/draw-strategy.hpp index 4f1ef7201..2fe308d5e 100644 --- a/src/gui/widget/timeline/draw-strategy.hpp +++ b/src/gui/widget/timeline/draw-strategy.hpp @@ -22,7 +22,10 @@ /** @file draw-strategy.hpp - ** TODO draw-strategy.hpp + ** Strategy interface for drawing timeline entities. This is part of the + ** first implementation draft of the timeline display. + ** @deprecated very likely to be completely rewritten. + ** @warning as of 2016 the entire timeline display is planned to be reworked */ diff --git a/src/gui/widget/timeline/timeline-arrow-tool.cpp b/src/gui/widget/timeline/timeline-arrow-tool.cpp index b00953bed..a64cff2fe 100644 --- a/src/gui/widget/timeline/timeline-arrow-tool.cpp +++ b/src/gui/widget/timeline/timeline-arrow-tool.cpp @@ -22,7 +22,7 @@ /** @file timeline-arrow-tool.cpp - ** TODO timeline-arrow-tool.cpp + ** @warning as of 2016 the entire timeline display is planned to be reworked */ diff --git a/src/gui/widget/timeline/timeline-arrow-tool.hpp b/src/gui/widget/timeline/timeline-arrow-tool.hpp index 5bbfefaaf..cc95695d9 100644 --- a/src/gui/widget/timeline/timeline-arrow-tool.hpp +++ b/src/gui/widget/timeline/timeline-arrow-tool.hpp @@ -22,6 +22,7 @@ /** @file timeline-arrow-tool.hpp ** This file contains the definition of the arrow tool class + ** @warning as of 2016 the entire timeline display is planned to be reworked */ #ifndef GUI_WIDGET_TIMELINE_ARROW_TOOL_H diff --git a/src/gui/widget/timeline/timeline-body.cpp b/src/gui/widget/timeline/timeline-body.cpp index cb5881d72..c9280a6aa 100644 --- a/src/gui/widget/timeline/timeline-body.cpp +++ b/src/gui/widget/timeline/timeline-body.cpp @@ -22,7 +22,7 @@ /** @file timeline-body.cpp - ** TODO timeline-body.cpp + ** @warning as of 2016 the entire timeline display is planned to be reworked */ diff --git a/src/gui/widget/timeline/timeline-body.hpp b/src/gui/widget/timeline/timeline-body.hpp index f31380f0d..99f08500a 100644 --- a/src/gui/widget/timeline/timeline-body.hpp +++ b/src/gui/widget/timeline/timeline-body.hpp @@ -22,6 +22,7 @@ /** @file timeline-body.hpp ** This file contains the definition of timeline body widget + ** @warning as of 2016 the entire timeline display is planned to be reworked */ #ifndef GUI_WIDGET_TIMELINE_BODY_H diff --git a/src/gui/widget/timeline/timeline-clip-track.cpp b/src/gui/widget/timeline/timeline-clip-track.cpp index 220b0d7f4..c21994131 100644 --- a/src/gui/widget/timeline/timeline-clip-track.cpp +++ b/src/gui/widget/timeline/timeline-clip-track.cpp @@ -22,7 +22,7 @@ /** @file timeline-clip-track.cpp - ** TODO timeline-clip-track.cpp + ** @warning as of 2016 the entire timeline display is planned to be reworked */ diff --git a/src/gui/widget/timeline/timeline-clip.cpp b/src/gui/widget/timeline/timeline-clip.cpp index 2d557b4bd..38ee1339a 100644 --- a/src/gui/widget/timeline/timeline-clip.cpp +++ b/src/gui/widget/timeline/timeline-clip.cpp @@ -22,7 +22,7 @@ /** @file timeline-clip.cpp - ** TODO timeline-clip.cpp + ** @warning as of 2016 the entire timeline display is planned to be reworked */ diff --git a/src/gui/widget/timeline/timeline-clip.hpp b/src/gui/widget/timeline/timeline-clip.hpp index 4a03a8c77..a62639f12 100644 --- a/src/gui/widget/timeline/timeline-clip.hpp +++ b/src/gui/widget/timeline/timeline-clip.hpp @@ -22,6 +22,7 @@ /** @file timeline-clip.hpp ** Representation of a clip on the timeline + ** @warning as of 2016 the entire timeline display is planned to be reworked */ #ifndef GUI_WIDGET_TIMELINE_CLIP_H diff --git a/src/gui/widget/timeline/timeline-entity.cpp b/src/gui/widget/timeline/timeline-entity.cpp index 73b865746..da3d4086f 100644 --- a/src/gui/widget/timeline/timeline-entity.cpp +++ b/src/gui/widget/timeline/timeline-entity.cpp @@ -22,7 +22,8 @@ /** @file timeline-entity.cpp - ** TODO timeline-entity.cpp + ** Implementation of a generic element to be placed onto the timeline + ** @warning as of 2016 the entire timeline display is planned to be reworked */ diff --git a/src/gui/widget/timeline/timeline-entity.hpp b/src/gui/widget/timeline/timeline-entity.hpp index 4abcea59e..381962f37 100644 --- a/src/gui/widget/timeline/timeline-entity.hpp +++ b/src/gui/widget/timeline/timeline-entity.hpp @@ -22,7 +22,8 @@ /** @file timeline-entity.hpp - ** any UI element that can be placed on the timeline. + ** Any UI element that can be placed on the timeline. + ** @warning as of 2016 the entire timeline display is planned to be reworked */ #ifndef GUI_WIDGET_TIMELINE_ENTITY_H diff --git a/src/gui/widget/timeline/timeline-group-track.cpp b/src/gui/widget/timeline/timeline-group-track.cpp index e8534cd69..ceed16d1d 100644 --- a/src/gui/widget/timeline/timeline-group-track.cpp +++ b/src/gui/widget/timeline/timeline-group-track.cpp @@ -22,7 +22,8 @@ /** @file timeline-group-track.cpp - ** TODO timeline-group-track.cpp + ** @deprecated to be replaced by a different implementation approach + ** @warning as of 2016 the entire timeline display is planned to be reworked */ diff --git a/src/gui/widget/timeline/timeline-group-track.hpp b/src/gui/widget/timeline/timeline-group-track.hpp index 882bdac52..6120116f6 100644 --- a/src/gui/widget/timeline/timeline-group-track.hpp +++ b/src/gui/widget/timeline/timeline-group-track.hpp @@ -22,7 +22,9 @@ /** @file timeline-group-track.hpp - ** TODO timeline-group-track.hpp + ** Preliminary implementation of a group track within the timeline display + ** @deprecated to be replaced by a different implementation approach + ** @warning as of 2016 the entire timeline display is planned to be reworked */ diff --git a/src/gui/widget/timeline/timeline-header-container.cpp b/src/gui/widget/timeline/timeline-header-container.cpp index 5818f56d5..95bb2ca8c 100644 --- a/src/gui/widget/timeline/timeline-header-container.cpp +++ b/src/gui/widget/timeline/timeline-header-container.cpp @@ -22,7 +22,7 @@ /** @file timeline-header-container.cpp - ** TODO timeline-header-container.cpp + ** @warning as of 2016 the entire timeline display is planned to be reworked */ diff --git a/src/gui/widget/timeline/timeline-header-container.hpp b/src/gui/widget/timeline/timeline-header-container.hpp index 60403f4a9..84ee305f6 100644 --- a/src/gui/widget/timeline/timeline-header-container.hpp +++ b/src/gui/widget/timeline/timeline-header-container.hpp @@ -22,7 +22,10 @@ /** @file timeline-header-container.hpp - ** TODO timeline-header-container.hpp + ** A container to hold the header area of the timeline display. + ** Most notably this was used to create a first version of the patchbay + ** and control areas for the tracks. Very likely to be completely rewritten. + ** @warning as of 2016 the entire timeline display is planned to be reworked */ diff --git a/src/gui/widget/timeline/timeline-header-widget.cpp b/src/gui/widget/timeline/timeline-header-widget.cpp index 877184899..b6cee96f1 100644 --- a/src/gui/widget/timeline/timeline-header-widget.cpp +++ b/src/gui/widget/timeline/timeline-header-widget.cpp @@ -22,7 +22,7 @@ /** @file timeline-header-widget.cpp - ** TODO timeline-header-widget.cpp + ** @warning as of 2016 the entire timeline display is planned to be reworked */ diff --git a/src/gui/widget/timeline/timeline-header-widget.hpp b/src/gui/widget/timeline/timeline-header-widget.hpp index 543fce7ca..ed4bbecda 100644 --- a/src/gui/widget/timeline/timeline-header-widget.hpp +++ b/src/gui/widget/timeline/timeline-header-widget.hpp @@ -22,7 +22,8 @@ /** @file timeline-header-widget.hpp - ** TODO timeline-header-widget.hpp + ** Widget to generate the timeline header + ** @warning as of 2016 the entire timeline display is planned to be reworked */ diff --git a/src/gui/widget/timeline/timeline-ibeam-tool.cpp b/src/gui/widget/timeline/timeline-ibeam-tool.cpp index 1002a5a2b..20f15a604 100644 --- a/src/gui/widget/timeline/timeline-ibeam-tool.cpp +++ b/src/gui/widget/timeline/timeline-ibeam-tool.cpp @@ -22,7 +22,7 @@ /** @file timeline-ibeam-tool.cpp - ** TODO timeline-ibeam-tool.cpp + ** @warning as of 2016 the entire timeline display is planned to be reworked */ diff --git a/src/gui/widget/timeline/timeline-ibeam-tool.hpp b/src/gui/widget/timeline/timeline-ibeam-tool.hpp index 95fec042b..f35778cd4 100644 --- a/src/gui/widget/timeline/timeline-ibeam-tool.hpp +++ b/src/gui/widget/timeline/timeline-ibeam-tool.hpp @@ -23,6 +23,7 @@ /** @file timeline-ibeam-tool.hpp ** A tool to select ranges in the timeline + ** @warning as of 2016 the entire timeline display is planned to be reworked */ #ifndef GUI_WIDGET_TIMELINE_IBEAM_TOOL_H diff --git a/src/gui/widget/timeline/timeline-layout-helper.cpp b/src/gui/widget/timeline/timeline-layout-helper.cpp index c6628709e..688a1f668 100644 --- a/src/gui/widget/timeline/timeline-layout-helper.cpp +++ b/src/gui/widget/timeline/timeline-layout-helper.cpp @@ -22,7 +22,8 @@ /** @file timeline-layout-helper.cpp - ** TODO timeline-layout-helper.cpp + ** Preliminary implementation of Timeline presentation, layout helper. + ** @deprecated as of 2016 this class will become obsolete and replaced by a different implementation approach */ diff --git a/src/gui/widget/timeline/timeline-layout-helper.hpp b/src/gui/widget/timeline/timeline-layout-helper.hpp index a7fcce429..1516f1f9e 100644 --- a/src/gui/widget/timeline/timeline-layout-helper.hpp +++ b/src/gui/widget/timeline/timeline-layout-helper.hpp @@ -20,8 +20,9 @@ */ /** @file timeline-layout-helper.cpp - ** This file contains the definition of the layout helper class + ** Preliminary implementation of Timeline presentation, layout helper. ** @todo this class should be thoroughly reworked; it seems to be kind of a "god class" ////////TODO 5/2015 + ** @deprecated as of 2016 this class will become obsolete and replaced by a different implementation approach */ diff --git a/src/gui/widget/timeline/timeline-ruler.cpp b/src/gui/widget/timeline/timeline-ruler.cpp index 58b88d833..a8dafacf4 100644 --- a/src/gui/widget/timeline/timeline-ruler.cpp +++ b/src/gui/widget/timeline/timeline-ruler.cpp @@ -22,7 +22,8 @@ /** @file timeline-ruler.cpp - ** TODO timeline-ruler.cpp + ** The ruler at the top of the timeline display to represent the time axis. + ** @warning as of 2016 the entire timeline display is planned to be reworked */ diff --git a/src/gui/widget/timeline/timeline-ruler.hpp b/src/gui/widget/timeline/timeline-ruler.hpp index 597544772..a90ad087b 100644 --- a/src/gui/widget/timeline/timeline-ruler.hpp +++ b/src/gui/widget/timeline/timeline-ruler.hpp @@ -22,7 +22,8 @@ /** @file timeline-ruler.hpp - ** TODO timeline-ruler.hpp + ** The ruler at the top of the timeline display to represent the time axis. + ** @warning as of 2016 the entire timeline display is planned to be reworked */ diff --git a/src/gui/widget/timeline/timeline-state.cpp b/src/gui/widget/timeline/timeline-state.cpp index c606b34b2..b8b088638 100644 --- a/src/gui/widget/timeline/timeline-state.cpp +++ b/src/gui/widget/timeline/timeline-state.cpp @@ -22,7 +22,8 @@ /** @file timeline-state.cpp - ** TODO timeline-state.cpp + ** Implementation of presentation state for the first draft of the timeline display. + ** @warning as of 2016 the entire timeline display is planned to be reworked */ diff --git a/src/gui/widget/timeline/timeline-state.hpp b/src/gui/widget/timeline/timeline-state.hpp index 8766d344c..0a8b4ff81 100644 --- a/src/gui/widget/timeline/timeline-state.hpp +++ b/src/gui/widget/timeline/timeline-state.hpp @@ -22,7 +22,9 @@ /** @file timeline-state.hpp - ** TODO timeline-state.hpp + ** Presentation state for the first draft of the timeline display. Very likely + ** to be replaced by a complete rewrite. + ** @warning as of 2016 the entire timeline display is planned to be reworked */ diff --git a/src/gui/widget/timeline/timeline-tool.cpp b/src/gui/widget/timeline/timeline-tool.cpp index 03d1baeda..ffc4d4b7b 100644 --- a/src/gui/widget/timeline/timeline-tool.cpp +++ b/src/gui/widget/timeline/timeline-tool.cpp @@ -22,7 +22,8 @@ /** @file timeline-tool.cpp - ** TODO timeline-tool.cpp + ** Tools and working modes for selections in the timeline. + ** @warning as of 2016 the entire timeline display is planned to be reworked */ diff --git a/src/gui/widget/timeline/timeline-tool.hpp b/src/gui/widget/timeline/timeline-tool.hpp index ade34456b..d5cccc785 100644 --- a/src/gui/widget/timeline/timeline-tool.hpp +++ b/src/gui/widget/timeline/timeline-tool.hpp @@ -22,7 +22,9 @@ /** @file timeline-tool.hpp - ** TODO timeline-tool.hpp + ** Tools and working modes for selections in the timeline. Most notably + ** the Arrow tool for object selection and the I-Beam tool for range selection. + ** @warning as of 2016 the entire timeline display is planned to be reworked */ diff --git a/src/gui/widget/timeline/timeline-track.cpp b/src/gui/widget/timeline/timeline-track.cpp index 125d9533c..6147592a2 100644 --- a/src/gui/widget/timeline/timeline-track.cpp +++ b/src/gui/widget/timeline/timeline-track.cpp @@ -22,7 +22,9 @@ /** @file timeline-track.cpp - ** TODO timeline-track.cpp + ** A group track in the first draft version of the timeline display. + ** @todo as of 2016 this is about to be replaced by a new implementation approach + ** @warning as of 2016 the entire timeline display is planned to be reworked */ diff --git a/src/gui/widget/timeline/timeline-track.hpp b/src/gui/widget/timeline/timeline-track.hpp index 47757c989..25b27968b 100644 --- a/src/gui/widget/timeline/timeline-track.hpp +++ b/src/gui/widget/timeline/timeline-track.hpp @@ -22,7 +22,9 @@ /** @file timeline-track.hpp - ** TODO timeline-track.hpp + ** A group track in the first draft version of the timeline display. + ** @todo as of 2016 this is about to be replaced by a new implementation approach + ** @warning as of 2016 the entire timeline display is planned to be reworked */ diff --git a/src/gui/widget/timeline/timeline-view-window.cpp b/src/gui/widget/timeline/timeline-view-window.cpp index beb99bb37..b3ae76e81 100644 --- a/src/gui/widget/timeline/timeline-view-window.cpp +++ b/src/gui/widget/timeline/timeline-view-window.cpp @@ -22,7 +22,8 @@ /** @file timeline-view-window.cpp - ** TODO timeline-view-window.cpp + ** Implementation of the timeline window, which holds the main timeline display. + ** @warning as of 2016 the entire timeline display is planned to be reworked */ diff --git a/src/gui/widget/timeline/timeline-view-window.hpp b/src/gui/widget/timeline/timeline-view-window.hpp index d5641b7db..19405279c 100644 --- a/src/gui/widget/timeline/timeline-view-window.hpp +++ b/src/gui/widget/timeline/timeline-view-window.hpp @@ -22,7 +22,8 @@ /** @file timeline-view-window.hpp - ** TODO timeline-view-window.hpp + ** Helper to manage the timeline window, which holds the main timeline display. + ** @warning as of 2016 the entire timeline display is planned to be reworked */ diff --git a/src/gui/widget/timeline/timeline-zoom-scale.cpp b/src/gui/widget/timeline/timeline-zoom-scale.cpp index 4cdc9252e..94e8a0945 100644 --- a/src/gui/widget/timeline/timeline-zoom-scale.cpp +++ b/src/gui/widget/timeline/timeline-zoom-scale.cpp @@ -22,7 +22,8 @@ /** @file timeline-zoom-scale.cpp - ** TODO timeline-zoom-scale.cpp + ** Widget to control timeline zoom scale + ** @warning as of 2016 the entire timeline display is planned to be reworked */ diff --git a/src/gui/widget/timeline/timeline-zoom-scale.hpp b/src/gui/widget/timeline/timeline-zoom-scale.hpp index d5bd87270..574fd0493 100644 --- a/src/gui/widget/timeline/timeline-zoom-scale.hpp +++ b/src/gui/widget/timeline/timeline-zoom-scale.hpp @@ -22,7 +22,8 @@ /** @file timeline-zoom-scale.hpp - ** TODO timeline-zoom-scale.hpp + ** Widget to control timeline zoom scale + ** @warning as of 2016 the entire timeline display is planned to be reworked */