projects
/
synfig.git
/ commitdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
| commitdiff |
tree
raw
|
patch
|
inline
| side by side (parent:
ea136b4
)
Added documentation for Factory and Book typedefs.
author
Diego Barrios Romero
<eldruin@gmail.com>
Mon, 21 Dec 2009 23:49:21 +0000
(
00:49
+0100)
committer
Diego Barrios Romero
<eldruin@gmail.com>
Mon, 21 Dec 2009 23:49:21 +0000
(
00:49
+0100)
synfig-core/src/synfig/layer.h
patch
|
blob
|
history
synfig-core/src/synfig/target.cpp
patch
|
blob
|
history
synfig-core/src/synfig/target.h
patch
|
blob
|
history
synfig-core/src/synfig/valuenode.h
patch
|
blob
|
history
diff --git
a/synfig-core/src/synfig/layer.h
b/synfig-core/src/synfig/layer.h
index
f729c40
..
1e321b0
100644
(file)
--- a/
synfig-core/src/synfig/layer.h
+++ b/
synfig-core/src/synfig/layer.h
@@
-162,7
+162,9
@@
class Layer : public Node
public:
public:
- //! Type that represents a pointer to a layer's constructor
+ //! Type that represents a pointer to a Layer's constructor.
+ /*! As a pointer to the constructor, it represents a "factory" of layers.
+ */
typedef Layer* (*Factory)();
struct BookEntry
typedef Layer* (*Factory)();
struct BookEntry
@@
-188,6
+190,13
@@
public:
version(version) { }
};
version(version) { }
};
+ //! Book of types of layers indexed by layer type name.
+ /*! While the sifz file is read, each time a new layer entry is found,
+ ** the factory constructor that the "factory" pointer member of the
+ ** "BookEntry" struct points to, is called, and a new layer of that type
+ ** is created.
+ ** \sa Layer::Factory
+ */
typedef std::map<String,BookEntry> Book;
static void register_in_book(const BookEntry &);
typedef std::map<String,BookEntry> Book;
static void register_in_book(const BookEntry &);
diff --git
a/synfig-core/src/synfig/target.cpp
b/synfig-core/src/synfig/target.cpp
index
6a73822
..
92153b4
100644
(file)
--- a/
synfig-core/src/synfig/target.cpp
+++ b/
synfig-core/src/synfig/target.cpp
@@
-54,6
+54,7
@@
Target::subsys_init()
default_gamma_=new synfig::Gamma(1.0/2.2);
//default_gamma_->set_black_level(0.05); // Default to 5% black level.
default_gamma_=new synfig::Gamma(1.0/2.2);
//default_gamma_->set_black_level(0.05); // Default to 5% black level.
+ // At least one target must be available.
book()["null"]=std::pair<synfig::Target::Factory,String>(Target_Null::create,"null");
ext_book()["null"]="null";
book()["null-tile"]=std::pair<synfig::Target::Factory,String>(Target_Null_Tile::create,"null-tile");
book()["null"]=std::pair<synfig::Target::Factory,String>(Target_Null::create,"null");
ext_book()["null"]="null";
book()["null-tile"]=std::pair<synfig::Target::Factory,String>(Target_Null_Tile::create,"null-tile");
diff --git
a/synfig-core/src/synfig/target.h
b/synfig-core/src/synfig/target.h
index
9f6e304
..
2f3c038
100644
(file)
--- a/
synfig-core/src/synfig/target.h
+++ b/
synfig-core/src/synfig/target.h
@@
-102,9
+102,16
@@
public:
*/
public:
*/
public:
+ //! Type that represents a pointer to a Target's constructor.
+ /*! As a pointer to the constructor, it represents a "factory" of targets.
+ ** Receives the output filename (including path).
+ */
typedef Target* (*Factory)(const char *filename);
typedef Target* (*Factory)(const char *filename);
- //! A type for a map of targets, indexed by the name of the Target
+ //! Book of types of targets indexed by the name of the Target.
+ /*! Each entry contains the Target constructor pointer and the output
+ ** filename string (including path).
+ */
typedef std::map<String,std::pair<Factory,String> > Book;
typedef std::map<String,String> ExtBook;
typedef std::map<String,std::pair<Factory,String> > Book;
typedef std::map<String,String> ExtBook;
diff --git
a/synfig-core/src/synfig/valuenode.h
b/synfig-core/src/synfig/valuenode.h
index
38e5c56
..
9b838b7
100644
(file)
--- a/
synfig-core/src/synfig/valuenode.h
+++ b/
synfig-core/src/synfig/valuenode.h
@@
-305,6
+305,9
@@
public:
//! Type that represents a pointer to a ValueNode's constructor
//! Type that represents a pointer to a ValueNode's constructor
+ /*! As a pointer to the constructor, it represents a "factory" of
+ ** objects of this class.
+ */
typedef LinkableValueNode* (*Factory)(const ValueBase&);
typedef bool (*CheckType)(ValueBase::Type);
typedef LinkableValueNode* (*Factory)(const ValueBase&);
typedef bool (*CheckType)(ValueBase::Type);
@@
-317,6
+320,13
@@
public:
ReleaseVersion release_version; // which version of synfig introduced this valuenode type
};
ReleaseVersion release_version; // which version of synfig introduced this valuenode type
};
+ //! Book of types of linkable value nodes indexed by type name.
+ /*! While the sifz file is read, each time a new LinkableValueNode entry
+ ** is found, the factory constructor that the "factory" pointer member
+ ** of the "BookEntry" struct points to, is called, and a new object of
+ ** that type is created.
+ ** \sa LinkableValueNode::Factory
+ */
typedef std::map<String,BookEntry> Book;
static Book& book();
typedef std::map<String,BookEntry> Book;
static Book& book();