Attention une mise à jour du service Gitlab va être effectuée le mardi 18 janvier (et non lundi 17 comme annoncé précédemment) entre 18h00 et 18h30. Cette mise à jour va générer une interruption du service dont nous ne maîtrisons pas complètement la durée mais qui ne devrait pas excéder quelques minutes.

Commit 9a0f112c authored by KLOCZKO Thibaud's avatar KLOCZKO Thibaud
Browse files

Add first step toward nice doc.

parent ef9e8f43
......@@ -10,6 +10,9 @@ src/dtk/dtkConfig.h
qml/*/qmldir
doc/html
doc/html*
## ###################################################################
## Insource build trees
## ###################################################################
......
#Include this file for a standard dtk module.
#include standard set of macros and C++ defines and ignores
include(fileextensions.qdocconf)
include(macros.qdocconf)
#extra configuration data DITA information
include(config.qdocconf)
naturallanguage = en_US
outputencoding = UTF-8
sourceencoding = UTF-8
examples.fileextensions = "*.cpp *.h *.js *.xq *.svg *.xml *.ui *.qhp *.qhcp *.qml *.css"
examples.imageextensions = "*.png *.jpg *.gif"
headers.fileextensions = "*.ch *.h *.h++ *.hh *.hpp *.hxx"
sources.fileextensions = "*.c++ *.cc *.cpp *.cxx *.tpp *.mm *.qml *.qdoc"
macro.aacute.HTML = "á"
macro.Aring.HTML = "Å"
macro.aring.HTML = "å"
macro.Auml.HTML = "Ä"
macro.author = "\\b{Author:}"
macro.br.HTML = "<br />"
macro.BR.HTML = "<br />"
macro.copyright.HTML = "&copy;"
macro.eacute.HTML = "&eacute;"
macro.gui = "\\b"
macro.hr.HTML = "<hr />"
macro.iacute.HTML = "&iacute;"
macro.key = "\\b"
macro.menu = "\\b"
macro.oslash.HTML = "&oslash;"
macro.ouml.HTML = "&ouml;"
macro.QA = "\\e{Qt Assistant}"
macro.QD = "\\e{Qt Designer}"
macro.QL = "\\e{Qt Linguist}"
macro.QQV = "\\e{Qt QML Viewer}"
macro.param = "\\e"
macro.raisedaster.HTML = "<sup>*</sup>"
macro.rarrow.HTML = "&rarr;"
macro.reg.HTML = "<sup>&reg;</sup>"
macro.return = "Returns"
macro.starslash = "\\c{*/}"
macro.begincomment = "\\c{/*}"
macro.endcomment = "\\c{*/}"
macro.uuml.HTML = "&uuml;"
macro.mdash.HTML = "&mdash;"
macro.pi.HTML = "&Pi;"
macro.beginqdoc.HTML = "/*!"
macro.endqdoc.HTML = "*/"
macro.beginfloatleft.HTML = "<div style=\"float: left; margin-right: 2em\">"
macro.beginfloatright.HTML = "<div style=\"float: right; margin-left: 2em\">"
macro.endfloat.HTML = "</div>"
macro.clearfloat.HTML = "<br style=\"clear: both\" />"
macro.emptyspan.HTML = "<span></span>"
include(../dtk/fileextensions.qdocconf)
include(../dtk/macros.qdocconf)
project = dtkCore
description = dtkCore Reference Documentation
url = http://dtk.inria.fr
outputdir = ../html
headerdirs = ../../src/dtkCore/
sourcedirs = ../../src/dtkCore/
exampledirs = .
imagedirs = .
sources.fileextensions += "*.tpp"
navigation.landingpage = "dtkCore"
navigation.cppclassespage = "dtkCore C++ Classes"
\ No newline at end of file
/*!
\module dtkCore
\title dtkCore C++ Classes
\brief Provides fundamental concepts and related tools.
dtkCore, is the foundation layer in dtk, the one that reflects its
intents as well as it's design. Other layers provided with dtk
rely on the core, and essentially provide thematic add-ons to
manipulate the fundamental concepts found in dtkCore such as data,
processes or views, for example by the mean of scripts, user
interfaces, or visual programming tools (that can be respectively
found in the dtkScript, dtkWidget and dtkComposer layers).
*/
......@@ -3,9 +3,9 @@
* Author: Julien Wintz
* Created: Thu Feb 28 16:28:31 2013 (+0100)
* Version:
* Last-Updated: Tue Mar 26 15:10:37 2013 (+0100)
* Last-Updated: mar. avril 1 14:26:46 2014 (+0200)
* By: Thibaud Kloczko
* Update #: 26
* Update #: 28
*/
/* Change Log:
......
......@@ -3,9 +3,9 @@
* Author: Julien Wintz
* Created: Thu Feb 28 15:43:06 2013 (+0100)
* Version:
* Last-Updated: Tue Apr 9 17:31:17 2013 (+0200)
* Last-Updated: mar. avril 1 16:59:36 2014 (+0200)
* By: Thibaud Kloczko
* Update #: 23
* Update #: 28
*/
/* Change Log:
......@@ -23,18 +23,18 @@
template <typename T> class dtkCorePluginFactory : public QObject
{
public:
dtkCorePluginFactory(void);
~dtkCorePluginFactory(void);
dtkCorePluginFactory();
~dtkCorePluginFactory();
#pragma mark -
#pragma mark Type creator definition
typedef T *(*creator) (void);
typedef T *(*creator) ();
#pragma mark -
#pragma mark Type creator registration
void record(QString key, creator func);
void record(const QString& key, creator func);
#pragma mark -
#pragma mark Type creator invokation
......@@ -44,7 +44,7 @@ public:
#pragma mark -
#pragma mark Type creator inspection
QStringList keys(void);
QStringList keys();
private:
QHash<QString, creator> creators;
......
/*!
\class dtkCorePluginFactory
\inmodule dtkCore
\brief The dtkCorePluginFactory class is a template class that provides a plugin factory for any template type.
*/
/*! \fn dtkCorePluginFactory::dtkCorePluginFactory()
Constructs the plugin factory.
*/
/*! \fn dtkCorePluginFactory::~dtkCorePluginFactory()
Destroys the plugin factory
*/
/*! \typedef dtkCorePluginFactory::creator
*/
/*! \fn void dtkCorePluginFactory::record(const QString& key, creator func)
Registers the creator function \a func under key \a key.
*/
/*! \fn T *dtkCorePluginFactory::create(const QString& key)
Creates object from the creator function identified by \a key.
Returns null pointer if \a key is not found.
*/
/*! \fn QStringList dtkCorePluginFactory::keys()
Returns all the recorded creator function keys.
*/
......@@ -2,24 +2,16 @@
*
* Author: Julien Wintz
* Created: Fri Feb 8 16:20:47 2013 (+0100)
* Version:
* Last-Updated: Wed Apr 10 11:22:57 2013 (+0200)
* By: Thibaud Kloczko
* Update #: 76
*/
/* Change Log:
*
*/
#pragma once
template <typename T> dtkCorePluginFactory<T>::dtkCorePluginFactory(void)
template <typename T> dtkCorePluginFactory<T>::dtkCorePluginFactory()
{
}
template <typename T> dtkCorePluginFactory<T>::~dtkCorePluginFactory(void)
template <typename T> dtkCorePluginFactory<T>::~dtkCorePluginFactory()
{
}
......@@ -27,7 +19,7 @@ template <typename T> dtkCorePluginFactory<T>::~dtkCorePluginFactory(void)
#pragma mark -
#pragma mark Type creator registration
template <typename T> void dtkCorePluginFactory<T>::record(QString key, creator func)
template <typename T> void dtkCorePluginFactory<T>::record(const QString& key, creator func)
{
if (this->creators.contains(key)) {
qDebug() << "Factory already contains key" << key << ". Nothing is done";
......@@ -51,7 +43,7 @@ template <typename T> T *dtkCorePluginFactory<T>::create(const QString& key)
#pragma mark -
#pragma mark Type creator inspection
template <typename T> QStringList dtkCorePluginFactory<T>::keys(void)
template <typename T> QStringList dtkCorePluginFactory<T>::keys()
{
return this->creators.keys();
}
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment