fix **** in doxygen comments
to make them stand out more prominently, some entity comments where started with a line of starts. Unfortunately, doxygen (and javadoc) only recogise comments which are started exactly with /** This caused quite some comments to be ignored by doxygen. Credits to Hendrik Boom for spotting this problem! A workaround is to end the line of stars with *//**
This commit is contained in:
parent
7967f6270d
commit
974c670d41
223 changed files with 228 additions and 228 deletions
|
|
@ -56,7 +56,7 @@ namespace engine {
|
|||
|
||||
|
||||
|
||||
/*******************************************************************
|
||||
/***************************************************************//**
|
||||
* Render engine diagnostic facility. Creating an instance
|
||||
* will activate additional tracing and diagnostic facilities
|
||||
* within the scheduler implementation; results may be investigated
|
||||
|
|
|
|||
|
|
@ -32,7 +32,7 @@
|
|||
namespace backend {
|
||||
|
||||
|
||||
/******************************************************************
|
||||
/**************************************************************//**
|
||||
* Interface to the backend layer (render engine subsystem):
|
||||
* Global access point for starting the render engine subsystem and
|
||||
* for defining the public interface(s) for talking with the engine.
|
||||
|
|
|
|||
|
|
@ -42,7 +42,7 @@ namespace backend {
|
|||
struct ChanDesc;
|
||||
|
||||
|
||||
/******************************************************************
|
||||
/**************************************************************//**
|
||||
* Interface to the backend layer:
|
||||
* provides functions for querying (opening) a media file,
|
||||
* detecting the channels or streams found within this file etc.
|
||||
|
|
|
|||
|
|
@ -32,7 +32,7 @@
|
|||
namespace backend {
|
||||
|
||||
|
||||
/******************************************************************
|
||||
/**************************************************************//**
|
||||
* Interface to the backend layer (renderfarm node):
|
||||
* Global access point for starting a server listening on a TCP port
|
||||
* and accepting render tasks. Possibly such a server could also
|
||||
|
|
|
|||
|
|
@ -32,7 +32,7 @@
|
|||
namespace backend {
|
||||
|
||||
|
||||
/***********************************************************************
|
||||
/*******************************************************************//**
|
||||
* Interface to the backend layer (script runner):
|
||||
* Global access point for starting a script within Lumiera application
|
||||
* context.
|
||||
|
|
|
|||
|
|
@ -53,7 +53,7 @@ namespace backend {
|
|||
|
||||
|
||||
|
||||
/****************************************************************************
|
||||
/************************************************************************//**
|
||||
* A thin convenience wrapper for dealing with threads,
|
||||
* as implemented by the threadpool in the backend (based on pthread).
|
||||
* Using this wrapper...
|
||||
|
|
|
|||
|
|
@ -65,7 +65,7 @@ namespace facade {
|
|||
using lib::Literal;
|
||||
|
||||
|
||||
/************************************************************************
|
||||
/********************************************************************//**
|
||||
* simple access-frontend to the implementation of a service (C++ only).
|
||||
* Usually, an instance of Accessor is placed as static member right into
|
||||
* the facade interface used to access the service. This implementation
|
||||
|
|
|
|||
|
|
@ -64,7 +64,7 @@ namespace lumiera {
|
|||
}
|
||||
|
||||
|
||||
/*****************************************************************************
|
||||
/*************************************************************************//**
|
||||
* Implementation helper for managing execution of a collection of subsystems,
|
||||
* which may depend on one another and execute in parallel. Properties of the
|
||||
* subsystems are available through Subsys object refs, which act as handle.
|
||||
|
|
|
|||
|
|
@ -72,7 +72,7 @@ namespace gui {
|
|||
|
||||
|
||||
|
||||
/********************************************************************
|
||||
/****************************************************************//**
|
||||
* Actual implementation of a single displayer slot. Internally,
|
||||
* it is connected via the Glib::Dispatcher for outputting frames
|
||||
* to a viewer widget, which executes within the GTK event thread.
|
||||
|
|
@ -109,7 +109,7 @@ namespace gui {
|
|||
|
||||
|
||||
|
||||
/******************************************************
|
||||
/**************************************************//**
|
||||
* Actual implementation of the DisplayService.
|
||||
* Creating an instance of this class automatically
|
||||
* registers the interface lumieraorg_Display with
|
||||
|
|
|
|||
|
|
@ -51,7 +51,7 @@ namespace gui {
|
|||
|
||||
|
||||
|
||||
/*********************************************************************
|
||||
/*****************************************************************//**
|
||||
* Global access point for loading and starting up the Lumiera GTK GUI
|
||||
* and for controlling the GUI lifecycle. The implementation part of
|
||||
* this class also is responsible for making the "business" interface
|
||||
|
|
|
|||
|
|
@ -79,7 +79,7 @@ namespace gui {
|
|||
|
||||
namespace { // implementation details
|
||||
|
||||
/******************************************************************************
|
||||
/**************************************************************************//**
|
||||
* Implement the necessary steps for actually making the Lumiera Gui available.
|
||||
* Open the business interface(s) and start up the GTK GUI main event loop.
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -49,7 +49,7 @@ namespace gui {
|
|||
|
||||
|
||||
|
||||
/******************************************************
|
||||
/**************************************************//**
|
||||
* Actual implementation of the GuiNotification service
|
||||
* within the Lumiera GTK GUI. Creating an instance of
|
||||
* this class automatically registers the interface
|
||||
|
|
|
|||
|
|
@ -55,7 +55,7 @@ namespace lumiera {
|
|||
using std::string;
|
||||
|
||||
|
||||
/*********************************************************************
|
||||
/*****************************************************************//**
|
||||
* C++ wrapper for convenient access to the Lumiera config system.
|
||||
*
|
||||
* @warning Config system not fully implemented yet. Thus for now
|
||||
|
|
|
|||
|
|
@ -60,7 +60,7 @@
|
|||
namespace lumiera {
|
||||
|
||||
|
||||
/******************************************************************
|
||||
/**************************************************************//**
|
||||
* Interface for outputting frames to an (already allocated) viewer
|
||||
* or display. The viewer is addressed by an "slot" handle, which the
|
||||
* client receives from some other public interface. This reflects
|
||||
|
|
|
|||
|
|
@ -48,7 +48,7 @@ namespace proc {
|
|||
namespace lumiera {
|
||||
|
||||
|
||||
/******************************************************************
|
||||
/**************************************************************//**
|
||||
* Experimental Interface Proc-Layer (or maybe the backend?):
|
||||
* Global access point for starting a dummy playback, generating
|
||||
* some test image data for the GUI to display in a viewer window.
|
||||
|
|
|
|||
|
|
@ -49,7 +49,7 @@ namespace gui {
|
|||
using std::string;
|
||||
|
||||
|
||||
/*********************************************************************
|
||||
/*****************************************************************//**
|
||||
* Global access point to push state update and notification of events
|
||||
* from the lower layers into the Lumiera GUI. Typically, this happens
|
||||
* asynchronously and triggered by events within the lower layers.
|
||||
|
|
|
|||
|
|
@ -89,7 +89,7 @@ namespace facade {
|
|||
LUMIERA_ERROR_DECLARE(FACADE_LIFECYCLE);
|
||||
|
||||
|
||||
/*********************************************************************
|
||||
/*****************************************************************//**
|
||||
* access-frontend to the implementation of a service.
|
||||
* Usually, an instance of Accessor is placed as static member
|
||||
* right into the facade interface used to access the service.
|
||||
|
|
|
|||
|
|
@ -59,7 +59,7 @@ namespace lumiera {
|
|||
using std::tr1::weak_ptr;
|
||||
|
||||
|
||||
/******************************************************************
|
||||
/**************************************************************//**
|
||||
* Interface to the Player subsystem of Lumiera (Proc-Layer).
|
||||
* Global access point for starting playback and render processes,
|
||||
* calculating media data by running the render engine.
|
||||
|
|
|
|||
|
|
@ -232,7 +232,7 @@ namespace lumiera {
|
|||
|
||||
} // namespace lumiera
|
||||
|
||||
/******************************************************
|
||||
/**************************************************//**
|
||||
* convenience shortcut for a sequence of catch blocks
|
||||
* just logging and consuming an error. Typically
|
||||
* this sequence will be used within destructors,
|
||||
|
|
@ -255,7 +255,7 @@ namespace lumiera {
|
|||
|
||||
|
||||
|
||||
/******************************************************
|
||||
/**************************************************//**
|
||||
* if NoBug is used, redefine some macros
|
||||
* to rather throw Lumiera Errors instead of aborting
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -123,7 +123,7 @@ namespace lib {
|
|||
|
||||
|
||||
|
||||
/************************************************************
|
||||
/********************************************************//**
|
||||
* A Mixin to add a private ID type to the target class,
|
||||
* together with storage to hold an instance of this ID,
|
||||
* getter and setter, and a templated version of the ID type
|
||||
|
|
|
|||
|
|
@ -72,7 +72,7 @@ namespace meta{
|
|||
|
||||
|
||||
|
||||
/******************************************************
|
||||
/**************************************************//**
|
||||
* Generic wrapper carrying a function object
|
||||
* while hiding the actual function signature
|
||||
* - create it using a function ref or pointer
|
||||
|
|
|
|||
|
|
@ -51,7 +51,7 @@ namespace lib {
|
|||
|
||||
namespace singleton {
|
||||
|
||||
/***************************************
|
||||
/***********************************//**
|
||||
* Detail/Policy class specifying
|
||||
* how the SingletonRef can be accessed
|
||||
*/
|
||||
|
|
@ -96,7 +96,7 @@ namespace lib {
|
|||
|
||||
|
||||
|
||||
/*************************************************************
|
||||
/*********************************************************//**
|
||||
* Helper template providing singleton access without managing
|
||||
* object creation and lifecycle. Just the access to the
|
||||
* implementation instance is handled: on creation, access is
|
||||
|
|
|
|||
|
|
@ -396,7 +396,7 @@ namespace lib {
|
|||
using sync::RecursiveLock_Waitable;
|
||||
|
||||
|
||||
/*************************************************************************
|
||||
/*********************************************************************//**
|
||||
* Facility for monitor object based locking.
|
||||
* To be attached either on a per class base or per object base.
|
||||
* Typically, the client class will inherit from this template (but it
|
||||
|
|
|
|||
|
|
@ -55,7 +55,7 @@ namespace asset {
|
|||
, META
|
||||
};
|
||||
|
||||
/*************************************
|
||||
/************************************************************************************//**
|
||||
* Tree like classification of Assets.
|
||||
* By virtue of the Category, Assets can be organised in nested bins (folders).
|
||||
* This includes the distinction of different kinds of Assets, like Audio, Video, Effects...
|
||||
|
|
|
|||
|
|
@ -72,7 +72,7 @@ namespace engine{
|
|||
|
||||
|
||||
|
||||
/*********************************************************
|
||||
/*****************************************************//**
|
||||
* A calculation stream groups and abstracts a series of
|
||||
* calculation jobs, delivering frames into the configured
|
||||
* OutputSlot in a timely fashion. Behind the scenes, this
|
||||
|
|
|
|||
|
|
@ -53,7 +53,7 @@ namespace engine {
|
|||
class TrackingHeapBlockProvider;
|
||||
|
||||
|
||||
/********************************************************************
|
||||
/****************************************************************//**
|
||||
* Helper for unit tests: Buffer provider reference implementation.
|
||||
*
|
||||
* @todo write type comment
|
||||
|
|
|
|||
|
|
@ -68,7 +68,7 @@ namespace engine{
|
|||
|
||||
|
||||
|
||||
/******************************************************
|
||||
/**************************************************//**
|
||||
* Render engine diagnostic facility. Creating an instance
|
||||
* will activate additional tracing facilities within the
|
||||
* render engine; results may be investigated through
|
||||
|
|
|
|||
|
|
@ -76,7 +76,7 @@ namespace engine{
|
|||
|
||||
|
||||
|
||||
/****************************************************************
|
||||
/************************************************************//**
|
||||
* Variant of the render engine, reconfigured for mock operation.
|
||||
* Especially, this setup leaves out most of the actual Lumiera
|
||||
* engine's implementation facilities. There is no scheduler
|
||||
|
|
|
|||
|
|
@ -85,7 +85,7 @@ namespace engine{
|
|||
|
||||
|
||||
|
||||
/******************************************************
|
||||
/**************************************************//**
|
||||
* A service to schedule series of calculations,
|
||||
* delivering the rendered data into an external output
|
||||
* sink in a timely fashion. Actually the CalculationStream
|
||||
|
|
@ -108,7 +108,7 @@ namespace engine{
|
|||
|
||||
|
||||
public:
|
||||
/*************************************************************
|
||||
/*********************************************************//**
|
||||
* Quality-of-Service definition for an Render Engine usage.
|
||||
* This strategy defines how to decide between conflicting goals like
|
||||
* - timely delivery
|
||||
|
|
|
|||
|
|
@ -53,7 +53,7 @@ namespace node {
|
|||
|
||||
|
||||
|
||||
/************************************************************
|
||||
/********************************************************//**
|
||||
* Tick generating service for a periodic callback,
|
||||
* with adjustable frequency. Quick'n dirty implementation!
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -53,7 +53,7 @@ namespace node {
|
|||
|
||||
|
||||
|
||||
/************************************************************
|
||||
/********************************************************//**
|
||||
* Tick generating service for a periodic callback,
|
||||
* with adjustable frequency. Quick'n dirty implementation!
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -43,7 +43,7 @@
|
|||
namespace proc {
|
||||
|
||||
|
||||
/*********************************************************************
|
||||
/*****************************************************************//**
|
||||
* Global access point for the services implemented by the Proc-Layer.
|
||||
*
|
||||
* @todo this is a dummy placeholder as of 1/2009. Currently, there
|
||||
|
|
|
|||
|
|
@ -102,7 +102,7 @@ namespace session {
|
|||
typedef PlacementIndex::ID ID;
|
||||
|
||||
|
||||
/*********************************************************************
|
||||
/*****************************************************************//**
|
||||
* Storage and implementation backing the PlacementIndex
|
||||
* - #placementTab_ is an hashtable mapping IDs to Placement + Scope
|
||||
* - #scopeTab_ is an reverse association serving to keep track of
|
||||
|
|
|
|||
|
|
@ -210,7 +210,7 @@ namespace play {
|
|||
}
|
||||
|
||||
|
||||
/********************************************************************
|
||||
/****************************************************************//**
|
||||
* Framework for dummy playback and rendering.
|
||||
* A DummyPlayConnection provides a coherent set of placeholders,
|
||||
* allowing to start a data producing process while leaving out
|
||||
|
|
|
|||
|
|
@ -69,7 +69,7 @@ namespace proc {
|
|||
|
||||
|
||||
|
||||
/********************************************************************
|
||||
/****************************************************************//**
|
||||
* Actual implementation of a single (dummy) playback process.
|
||||
* The DummyPlayerService (see below) maintains a collection of such
|
||||
* actively running playback processes, while the client code gets
|
||||
|
|
@ -117,7 +117,7 @@ namespace proc {
|
|||
|
||||
|
||||
|
||||
/******************************************************
|
||||
/**************************************************//**
|
||||
* Actual implementation of the DummyPlayer service.
|
||||
* Creating an instance of this class automatically
|
||||
* registers the interface lumieraorg_DummyPlayer with
|
||||
|
|
|
|||
|
|
@ -64,7 +64,7 @@ namespace play {
|
|||
|
||||
|
||||
|
||||
/******************************************************
|
||||
/**************************************************//**
|
||||
* Management of external Output connections.
|
||||
*
|
||||
* @todo write Type comment
|
||||
|
|
|
|||
|
|
@ -58,7 +58,7 @@ namespace play {
|
|||
|
||||
|
||||
|
||||
/******************************************************
|
||||
/**************************************************//**
|
||||
* Management of external Output connections.
|
||||
*
|
||||
* @todo need a concrete implementation
|
||||
|
|
|
|||
|
|
@ -95,7 +95,7 @@ namespace play {
|
|||
|
||||
|
||||
|
||||
/********************************************************************************
|
||||
/****************************************************************************//**
|
||||
* Interface: Generic output sink.
|
||||
* An OutputSlot represents the possibility to send data through multiple
|
||||
* channels to some kind of external sink (video in GUI window, video full screen,
|
||||
|
|
|
|||
|
|
@ -48,7 +48,7 @@ namespace play {
|
|||
using std::string;
|
||||
|
||||
|
||||
/********************************************************************
|
||||
/****************************************************************//**
|
||||
* TODO do we still need that??????
|
||||
* Isn't lumiera::Play::Controller already sufficient?
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -111,7 +111,7 @@ namespace play {
|
|||
typedef std::vector<Feed> OutputFeeds;
|
||||
|
||||
|
||||
/******************************************************
|
||||
/**************************************************//**
|
||||
* Playback/Render process within the Lumiera Player.
|
||||
* This is a top-level implementation entity, created
|
||||
* by the PlayService when \em performing a timeline
|
||||
|
|
|
|||
|
|
@ -83,7 +83,7 @@ namespace play {
|
|||
|
||||
|
||||
|
||||
/******************************************************
|
||||
/**************************************************//**
|
||||
* Implementation access point: Player subsystem.
|
||||
* The PlayService is the primary way for clients to
|
||||
* get into using Lumiera's Play/Output Subsystem.
|
||||
|
|
|
|||
|
|
@ -85,7 +85,7 @@ namespace play {
|
|||
|
||||
|
||||
|
||||
/*****************************************************************************
|
||||
/*************************************************************************//**
|
||||
* Generic frame timing specification. Defines the expected delivery interval,
|
||||
* optionally also the expected quality-of-service (urgency).
|
||||
*
|
||||
|
|
|
|||
|
|
@ -39,7 +39,7 @@ namespace test {
|
|||
|
||||
|
||||
|
||||
/***************************************************************************
|
||||
/**********************************************************************//**
|
||||
* @test verify the basic properties of the job and job descriptor struct;
|
||||
* especially verify that job data is passed properly back to the
|
||||
* closure and that a identity can be constructed based on a
|
||||
|
|
|
|||
|
|
@ -62,7 +62,7 @@ namespace test {
|
|||
typedef SchedulerFrontend::JobTransaction JobTransaction;
|
||||
|
||||
|
||||
/***************************************************************************
|
||||
/***********************************************************************//**
|
||||
* @test verify and demonstrate the organisation of the high-level interface
|
||||
* for defining jobs to be invoked by the scheduler.
|
||||
*
|
||||
|
|
|
|||
|
|
@ -44,7 +44,7 @@ namespace test {
|
|||
|
||||
|
||||
|
||||
/********************************************************************************
|
||||
/****************************************************************************//**
|
||||
* @test inject a Mock object replacing the backend_interface::MediaAccessFacade.
|
||||
* Verify if the Mock object behaves as expected when calling the Facade.
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -43,7 +43,7 @@ namespace test {
|
|||
|
||||
|
||||
|
||||
/***********************************************************************
|
||||
/*******************************************************************//**
|
||||
* @test checking the properties of Asset Category structs.
|
||||
* They are included in the Asset::Ident identification tuple
|
||||
* of Assets and can be used to organize Assets into a tree
|
||||
|
|
|
|||
|
|
@ -51,7 +51,7 @@ namespace test {
|
|||
|
||||
|
||||
|
||||
/***********************************************************************
|
||||
/*******************************************************************//**
|
||||
* @test basic properties of Pipe (structural) Assets.
|
||||
* <ul><li>created by referral</li>
|
||||
* <li>access existing pipe by referral</li>
|
||||
|
|
|
|||
|
|
@ -42,7 +42,7 @@ namespace test {
|
|||
|
||||
|
||||
|
||||
/***********************************************************************
|
||||
/*******************************************************************//**
|
||||
* Verifying the special operations available for compound media assets
|
||||
* comprised of several elementary media assets.
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -45,7 +45,7 @@ namespace test {
|
|||
|
||||
|
||||
|
||||
/***********************************************************************
|
||||
/*******************************************************************//**
|
||||
* @test creating new Assets and registering them with the AssetManager.
|
||||
* @see proc_interface::AssetManager#reg
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -37,7 +37,7 @@ namespace test {
|
|||
|
||||
|
||||
|
||||
/*******************************************************************
|
||||
/***************************************************************//**
|
||||
* @test deleting an Asset includes removing all dependent Assets
|
||||
* and all MObjects relying on these. Especially this means
|
||||
* breaking all links between the involved Objects, so the
|
||||
|
|
|
|||
|
|
@ -43,7 +43,7 @@ namespace test {
|
|||
|
||||
|
||||
|
||||
/*******************************************************************
|
||||
/***************************************************************//**
|
||||
* @test the handling of Assets dependent on other Assets and the
|
||||
* enabling/disabling of Assets.
|
||||
* @see asset::Asset
|
||||
|
|
|
|||
|
|
@ -66,7 +66,7 @@ namespace test {
|
|||
|
||||
|
||||
|
||||
/***************************************************************************
|
||||
/***********************************************************************//**
|
||||
* @test proof-of-concept test for a combined symbolic and hash based ID.
|
||||
* - create some symbolic IDs
|
||||
* - check default assignment works properly
|
||||
|
|
|
|||
|
|
@ -45,7 +45,7 @@ namespace test {
|
|||
|
||||
|
||||
|
||||
/***********************************************************************
|
||||
/*******************************************************************//**
|
||||
* @test creating several Assets and checking object identity,
|
||||
* detection of duplicates and version handling.
|
||||
* @see proc_interface::AssetManager#reg
|
||||
|
|
|
|||
|
|
@ -47,7 +47,7 @@ namespace test {
|
|||
|
||||
|
||||
|
||||
/***********************************************************************
|
||||
/*******************************************************************//**
|
||||
* @test creating a Clip MObject and an associated Clip Asset from
|
||||
* a given asset::Media.
|
||||
* @see asset::Media#createClip
|
||||
|
|
|
|||
|
|
@ -41,7 +41,7 @@ namespace test {
|
|||
|
||||
|
||||
|
||||
/***********************************************************************
|
||||
/*******************************************************************//**
|
||||
* This test documents the Interface used by MediaFactory when loading
|
||||
* media files for querying Lumiera's backend layer for information
|
||||
* on how the media file is structured.
|
||||
|
|
|
|||
|
|
@ -61,7 +61,7 @@ namespace test {
|
|||
|
||||
|
||||
|
||||
/***************************************************************************
|
||||
/***********************************************************************//**
|
||||
* @test build some simple time grids and verify their behaviour
|
||||
* for quantising (grid aligning) time values.
|
||||
*
|
||||
|
|
|
|||
|
|
@ -44,7 +44,7 @@ namespace test {
|
|||
|
||||
|
||||
|
||||
/******************************************************
|
||||
/**************************************************//**
|
||||
* @test validate the equality and order relations of
|
||||
* Asset::Ident and Asset objects.
|
||||
* @note a known problem is that only Asset smart ptrs
|
||||
|
|
|
|||
|
|
@ -99,7 +99,7 @@ namespace test {
|
|||
|
||||
|
||||
|
||||
/***************************************************************************
|
||||
/***********************************************************************//**
|
||||
* @test outline of an instance registration and accounting service.
|
||||
* The service is self-contained and supports automatic registration
|
||||
* and deregistration. The instance access is configurable on a
|
||||
|
|
|
|||
|
|
@ -91,7 +91,7 @@ namespace test {
|
|||
|
||||
|
||||
|
||||
/*************************************************************
|
||||
/*********************************************************//**
|
||||
* @test Build a test object, which accepts a bind(...) call
|
||||
* with specifically typed arguments.
|
||||
*
|
||||
|
|
|
|||
|
|
@ -186,7 +186,7 @@ namespace test {
|
|||
|
||||
typedef lib::ScopedPtrVect<CmdClosure> ArgTuples;
|
||||
|
||||
/***************************************************************************
|
||||
/***********************************************************************//**
|
||||
* @test Check storage handling of the command parameters and state memento.
|
||||
*
|
||||
* @see control::CommandArgumentHolder
|
||||
|
|
|
|||
|
|
@ -68,7 +68,7 @@ namespace test {
|
|||
|
||||
|
||||
|
||||
/***************************************************************************
|
||||
/***********************************************************************//**
|
||||
* @test basic usage of the Proc-Layer command dispatch system.
|
||||
* Shows how to define a simple command inline and how to
|
||||
* trigger execution and UNDO. Verifies the command action
|
||||
|
|
|
|||
|
|
@ -42,7 +42,7 @@ namespace test {
|
|||
|
||||
|
||||
|
||||
/*****************************************************************************
|
||||
/*************************************************************************//**
|
||||
* @test coverage for some specific situations when binding command arguments.
|
||||
*
|
||||
* @todo add more test cases...
|
||||
|
|
|
|||
|
|
@ -52,7 +52,7 @@ namespace test {
|
|||
|
||||
|
||||
|
||||
/********************************************************************************
|
||||
/****************************************************************************//**
|
||||
* @test check creation of a command implementation clone from top level,
|
||||
* without disclosing specific type information about the involved closure.
|
||||
* This includes verifying sane allocation management.
|
||||
|
|
|
|||
|
|
@ -90,7 +90,7 @@ namespace test {
|
|||
|
||||
|
||||
|
||||
/*****************************************************************************************
|
||||
/*************************************************************************************//**
|
||||
* @test cover command equality detection. Two commands are deemed equivalent, if they
|
||||
* - build on the same Mutation functors
|
||||
* - are either both incomplete or
|
||||
|
|
|
|||
|
|
@ -69,7 +69,7 @@ namespace test {
|
|||
|
||||
|
||||
|
||||
/***************************************************************************
|
||||
/***********************************************************************//**
|
||||
* Verify the behaviour of the type erased closure, which is used
|
||||
* by Proc-Layer commands to implement the capturing and later
|
||||
* re-invocation of a function.
|
||||
|
|
|
|||
|
|
@ -51,7 +51,7 @@ namespace test {
|
|||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
/***************************************************************************//**
|
||||
* @test verify sane behaviour of the relevant operations on the CommandRegistry
|
||||
* interface. Add/remove a command instance to the index, allocate an
|
||||
* CommandImpl frame and verify it is removed properly on ref count zero.
|
||||
|
|
|
|||
|
|
@ -49,7 +49,7 @@ namespace test {
|
|||
|
||||
|
||||
|
||||
/***************************************************************************
|
||||
/***********************************************************************//**
|
||||
* @test command usage aspects I: defining commands in various ways,
|
||||
* then re-accessing those definitions, create instances,
|
||||
* invoke them and undo the effect. Clean up finally.
|
||||
|
|
|
|||
|
|
@ -71,7 +71,7 @@ namespace test {
|
|||
|
||||
|
||||
|
||||
/***************************************************************************
|
||||
/***********************************************************************//**
|
||||
* @test command usage aspects II: patterns of invoking commands.
|
||||
*
|
||||
* @todo this test is still on hold, as the non-trivial patterns aren't implemented as of 10/09
|
||||
|
|
|
|||
|
|
@ -60,7 +60,7 @@ namespace test {
|
|||
|
||||
|
||||
|
||||
/***************************************************************************
|
||||
/***********************************************************************//**
|
||||
* @test command usage aspects III: elaborate handling patterns, like e.g.
|
||||
* asynchronous or repeated invocation and command sequence bundles.
|
||||
*
|
||||
|
|
|
|||
|
|
@ -55,7 +55,7 @@ namespace test {
|
|||
|
||||
|
||||
|
||||
/**********************************************************************************
|
||||
/******************************************************************************//**
|
||||
* @test operate and verify a simple dummy command handling pattern.
|
||||
* @note this test covers mainly the behaviour of a handling pattern as a concept,
|
||||
* not so much the behaviour of the (standard) handling pattern implementations.
|
||||
|
|
|
|||
|
|
@ -83,7 +83,7 @@ namespace test {
|
|||
|
||||
|
||||
|
||||
/***********************************************************************
|
||||
/*******************************************************************//**
|
||||
* @test verify correct behaviour of all the command handling patterns
|
||||
* provided by the default configuration of a lumiera session.
|
||||
* - executing quasi synchronous
|
||||
|
|
|
|||
|
|
@ -65,7 +65,7 @@ namespace test {
|
|||
|
||||
|
||||
|
||||
/*****************************************************************************************
|
||||
/*************************************************************************************//**
|
||||
* @test Verify the state capturing mechanism (memento), which is used to implement
|
||||
* the Undo() functionality for Proc-Layer commands. Bind an undo function and a state
|
||||
* capturing function and wire up both to store and retrieve a memento value.
|
||||
|
|
|
|||
|
|
@ -122,7 +122,7 @@ namespace test {
|
|||
|
||||
|
||||
|
||||
/*******************************************************************
|
||||
/***************************************************************//**
|
||||
* @test create a random pattern of recursive invocations, each
|
||||
* allocating a chunk out of a global buffer table storage.
|
||||
* After returning, each allocation should be cleanly
|
||||
|
|
|
|||
|
|
@ -155,7 +155,7 @@ namespace test {
|
|||
|
||||
|
||||
|
||||
/***********************************************************************
|
||||
/*******************************************************************//**
|
||||
* @test verify calculation and relations of Buffer metadata type keys.
|
||||
* These are used internally within the standard implementation
|
||||
* of BufferProvider to keep track of various kinds of buffers,
|
||||
|
|
|
|||
|
|
@ -74,7 +74,7 @@ namespace test {
|
|||
|
||||
|
||||
|
||||
/*******************************************************************
|
||||
/***************************************************************//**
|
||||
* @test verify the properties of the BufferMetadata records used
|
||||
* internally within BufferProvider to attach additional
|
||||
* organisational data to the exposed buffers.
|
||||
|
|
|
|||
|
|
@ -61,7 +61,7 @@ namespace test {
|
|||
}
|
||||
|
||||
|
||||
/******************************************************************************
|
||||
/**************************************************************************//**
|
||||
* @test verify and demonstrate the usage cycle of data buffers for the engine
|
||||
* based on the BufferProvider interface. This is kind of a "dry run"
|
||||
* for documentation purposes, because the BufferProvider implementation
|
||||
|
|
|
|||
|
|
@ -45,7 +45,7 @@ namespace test {
|
|||
|
||||
|
||||
|
||||
/*******************************************************************
|
||||
/***************************************************************//**
|
||||
* @test detailed coverage of the various CalcStream flavours
|
||||
* supported by the render engine interface.
|
||||
*
|
||||
|
|
|
|||
|
|
@ -143,7 +143,7 @@ namespace test {
|
|||
|
||||
|
||||
|
||||
/*******************************************************************
|
||||
/***************************************************************//**
|
||||
* @test document and verify the engine::Dispatcher interface, used
|
||||
* to translate a CalcStream into individual node jobs.
|
||||
* This test covers the definition of the interface itself,
|
||||
|
|
|
|||
|
|
@ -63,7 +63,7 @@ namespace test {
|
|||
|
||||
|
||||
|
||||
/*******************************************************************
|
||||
/***************************************************************//**
|
||||
* @test cover the basic service exposed at the engine interface:
|
||||
* create a calculation stream and verify the translation
|
||||
* into individual jobs.
|
||||
|
|
|
|||
|
|
@ -71,7 +71,7 @@ namespace test {
|
|||
}
|
||||
|
||||
|
||||
/*******************************************************************
|
||||
/***************************************************************//**
|
||||
* @test basic render node properties and behaviour.
|
||||
*/
|
||||
class NodeBasic_test : public Test
|
||||
|
|
|
|||
|
|
@ -39,7 +39,7 @@ namespace test {
|
|||
|
||||
|
||||
|
||||
/*******************************************************************
|
||||
/***************************************************************//**
|
||||
* @test creating and wiring various kinds of render nodes.
|
||||
*/
|
||||
class NodeFabrication_test : public Test
|
||||
|
|
|
|||
|
|
@ -39,7 +39,7 @@ namespace test {
|
|||
|
||||
|
||||
|
||||
/*******************************************************************
|
||||
/***************************************************************//**
|
||||
* @test check render node operation modes and collaboration.
|
||||
*/
|
||||
class NodeOperation_test : public Test
|
||||
|
|
|
|||
|
|
@ -39,7 +39,7 @@ namespace test {
|
|||
|
||||
|
||||
|
||||
/*******************************************************************
|
||||
/***************************************************************//**
|
||||
* @test the source reading render node.
|
||||
*/
|
||||
class NodeSource_test : public Test
|
||||
|
|
|
|||
|
|
@ -56,7 +56,7 @@ namespace test {
|
|||
|
||||
|
||||
|
||||
/*******************************************************************
|
||||
/***************************************************************//**
|
||||
* @test verify test helper for engine tests: a dummy data frame.
|
||||
* TestFrame instances can be created right away, without any
|
||||
* external library dependencies. A test frame is automatically
|
||||
|
|
|
|||
|
|
@ -66,7 +66,7 @@ namespace test {
|
|||
}
|
||||
|
||||
|
||||
/**********************************************************************
|
||||
/******************************************************************//**
|
||||
* @test verify a test support facility, used to write mock components
|
||||
* to test the lumiera engine. The TrackingHeapBlockProvider is a
|
||||
* braindead implementation of the BufferProvider interface: it just
|
||||
|
|
|
|||
|
|
@ -94,7 +94,7 @@ namespace test {
|
|||
|
||||
|
||||
|
||||
/*************************************************************************************
|
||||
/*********************************************************************************//**
|
||||
* @test the generic visitor pattern specialised for treating MObjects in the builder.
|
||||
* Besides using existing MObject types (at the moment session::Clip),
|
||||
* we create a yet-unknown new MObject subclass. When passing such to any
|
||||
|
|
|
|||
|
|
@ -40,7 +40,7 @@ namespace test {
|
|||
|
||||
|
||||
|
||||
/*******************************************************************
|
||||
/***************************************************************//**
|
||||
* @test the builder core functionality: create a render pipeline
|
||||
* for a given segment of the Session/Timeline.
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -82,7 +82,7 @@ namespace test {
|
|||
|
||||
|
||||
|
||||
/*********************************************************************************
|
||||
/*****************************************************************************//**
|
||||
* @test TODO blubb
|
||||
*
|
||||
* @see mobject::builder::FixtureChangeDetector
|
||||
|
|
|
|||
|
|
@ -90,7 +90,7 @@ namespace test {
|
|||
|
||||
|
||||
|
||||
/*********************************************************************************
|
||||
/*****************************************************************************//**
|
||||
* @test create a standalone model port registry to verify the behaviour of
|
||||
* model ports, accessed through reference handles. This test provides an
|
||||
* example setup detached from the real usage situation within the builder.
|
||||
|
|
|
|||
|
|
@ -82,7 +82,7 @@ namespace test {
|
|||
|
||||
|
||||
|
||||
/*********************************************************************************
|
||||
/*****************************************************************************//**
|
||||
* @test TODO blubb
|
||||
*
|
||||
* @see mobject::builder::FixtureChangeDetector
|
||||
|
|
|
|||
|
|
@ -40,7 +40,7 @@ namespace test {
|
|||
|
||||
|
||||
|
||||
/********************************************************************
|
||||
/****************************************************************//**
|
||||
* @test create a render process from a given segment of the Session.
|
||||
* Basically this includes cooperation of all parts of the
|
||||
* Lumiera Proc Layer. For a prepared test-Session we invoke the
|
||||
|
|
|
|||
|
|
@ -68,7 +68,7 @@ namespace test {
|
|||
typedef TestPlacement<DummyMO> PDummy;
|
||||
|
||||
|
||||
/*********************************************************************************
|
||||
/*****************************************************************************//**
|
||||
* @test cover the common behaviour of all MObjects.
|
||||
* @note the MObject interface is still very preliminary (as of 10/10).
|
||||
* It is expected to support some kind of metadata and object serialisation
|
||||
|
|
|
|||
|
|
@ -84,7 +84,7 @@ namespace test {
|
|||
|
||||
|
||||
|
||||
/***************************************************************************
|
||||
/***********************************************************************//**
|
||||
* @test properties and behaviour of the external reference-mechanism for
|
||||
* MObjects placed into the session. We create a simple, simulated
|
||||
* "session" (no real session datastructure) and a mock PlacementIndex.
|
||||
|
|
|
|||
|
|
@ -45,7 +45,7 @@ namespace test {
|
|||
typedef asset::ID<Pipe> PID;
|
||||
|
||||
|
||||
/*********************************************************************************
|
||||
/*****************************************************************************//**
|
||||
* @test create a synthetic / example mapping to verify generic mapping behaviour.
|
||||
* We're creating a custom mapping type here, for this test only: The
|
||||
* struct DummyDef provides a "definition context" for this custom mapping
|
||||
|
|
|
|||
|
|
@ -48,7 +48,7 @@ namespace test {
|
|||
|
||||
|
||||
|
||||
/*******************************************************************
|
||||
/***************************************************************//**
|
||||
* @test basic behaviour of Placements and access to MObjects.
|
||||
* @see mobject::Placement
|
||||
* @see mobject::MObject#create
|
||||
|
|
|
|||
|
|
@ -55,7 +55,7 @@ namespace test {
|
|||
using lumiera::error::LUMIERA_ERROR_ASSERTION;
|
||||
|
||||
|
||||
/***************************************************************************************
|
||||
/***********************************************************************************//**
|
||||
* @test creating placements specifically typed, forming an hierarchy of placement types
|
||||
* which loosely mirrors the hierarchy of the pointee types. Assignments between
|
||||
* placement of differing type, while still sharing ownership.
|
||||
|
|
|
|||
|
|
@ -52,7 +52,7 @@ namespace test {
|
|||
|
||||
|
||||
|
||||
/***************************************************************************
|
||||
/***********************************************************************//**
|
||||
* @test verify correct handling of object identity. Create test objects,
|
||||
* add placements to a dummy index/session, then create PlacementRef
|
||||
* and MObjectRef handles. Finally do cross comparisons.
|
||||
|
|
|
|||
|
|
@ -51,7 +51,7 @@ namespace test {
|
|||
typedef PlacementMO::ID P_ID;
|
||||
|
||||
|
||||
/***************************************************************************
|
||||
/***********************************************************************//**
|
||||
* @test properties and behaviour of the reference-mechanism for Placements.
|
||||
* We create an mock placement index and install it to be used
|
||||
* by all PlacementRef instances while conducting this test.
|
||||
|
|
|
|||
|
|
@ -44,7 +44,7 @@ namespace test {
|
|||
|
||||
|
||||
|
||||
/*******************************************************************
|
||||
/***************************************************************//**
|
||||
* @test adding an test clip to the Model/Session.
|
||||
* @see mobject::session::Clip
|
||||
* @see mobject::Session
|
||||
|
|
|
|||
|
|
@ -81,7 +81,7 @@ namespace test {
|
|||
|
||||
|
||||
|
||||
/************************************************************************
|
||||
/********************************************************************//**
|
||||
* @test verify some general assumptions regarding implementation details
|
||||
* of the the defaults manager.
|
||||
* @see DefsManager_test for the "big picture"
|
||||
|
|
|
|||
Some files were not shown because too many files have changed in this diff Show more
Loading…
Reference in a new issue