Doxygen: fill in missing file level headlines for the GUI

This commit is contained in:
Fischlurch 2016-11-06 14:19:14 +01:00
parent f694f9aa2d
commit b258bc9275
73 changed files with 191 additions and 77 deletions

View file

@ -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.
*/

View file

@ -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.
*/

View file

@ -22,7 +22,7 @@
/** @file dialog.hpp
** TODO dialog.hpp
** Global constants and definitions for dialogs.
*/

View file

@ -22,7 +22,8 @@
/** @file name-chooser.cpp
** TODO name-chooser.cpp
** Implementation details of NameChooser,
** a dialog to enter a name string.
*/

View file

@ -22,7 +22,7 @@
/** @file name-chooser.hpp
** TODO name-chooser.hpp
** Dialog to enter a string name.
*/

View file

@ -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.
*/

View file

@ -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.
*/

View file

@ -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.
**
*/

View file

@ -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

View file

@ -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"

View file

@ -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.
*/

View file

@ -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.
*/

View file

@ -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

View file

@ -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"

View file

@ -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
{

View file

@ -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"

View file

@ -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,

View file

@ -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.
**
*/

View file

@ -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

View file

@ -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"

View file

@ -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.
*/

View file

@ -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
*/

View file

@ -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
*/

View file

@ -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.
*/

View file

@ -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.
*/

View file

@ -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
*/

View file

@ -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.
*/

View file

@ -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
*/

View file

@ -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"

View file

@ -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
*/

View file

@ -22,7 +22,7 @@
/** @file panel.cpp
** TODO panel.cpp
** Implementation base for all dockable panels
*/

View file

@ -22,7 +22,7 @@
/** @file panel.hpp
** TODO panel.hpp
** Base class and interface for all dockable panels
*/

View file

@ -22,7 +22,7 @@
/** @file timeline-panel.cpp
** TODO timeline-panel.cpp
** Implementation of the dockable panel to hold the main timeline display.
*/

View file

@ -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"

View file

@ -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
*/

View file

@ -22,7 +22,7 @@
/** @file cairo-util.cpp
** TODO cairo-util.cpp
** Implementation of helper functions to support working with lib Cairo
*/

View file

@ -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 <cairomm/cairomm.h>

View file

@ -22,7 +22,7 @@
/** @file rectangle.cpp
** TODO rectangle.cpp
** Implementation of functions to work with rectangular screen ranges
*/
#include "gui/util/rectangle.hpp"

View file

@ -22,7 +22,7 @@
/** @file rectangle.hpp
** TODO rectangle.hpp
** Helper functions to work with rectangular screen ranges
*/

View file

@ -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
*/

View file

@ -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
*/

View file

@ -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
*/

View file

@ -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
*/

View file

@ -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

View file

@ -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
*/

View file

@ -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

View file

@ -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
*/

View file

@ -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
*/

View file

@ -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

View file

@ -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
*/

View file

@ -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

View file

@ -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
*/

View file

@ -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
*/

View file

@ -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
*/

View file

@ -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
*/

View file

@ -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
*/

View file

@ -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
*/

View file

@ -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
*/

View file

@ -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

View file

@ -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
*/

View file

@ -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
*/

View file

@ -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
*/

View file

@ -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
*/

View file

@ -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
*/

View file

@ -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
*/

View file

@ -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
*/

View file

@ -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
*/

View file

@ -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
*/

View file

@ -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
*/

View file

@ -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
*/

View file

@ -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
*/

View file

@ -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
*/

View file

@ -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
*/