X-Git-Url: https://git.pterodactylus.net/?a=blobdiff_plain;f=synfig-core%2Fsrc%2Fsynfig%2Fimporter.h;h=ce89da5e8fca0c8502135a0566c8956dede8aeb5;hb=ed87e08cbcd778f84e570a981ae61aa1178c82ff;hp=30ec899a5db5e5f749747301cf05bdf21ed15823;hpb=37a745c011b9e7be0d91e0df500d4f14837c8706;p=synfig.git

diff --git a/synfig-core/src/synfig/importer.h b/synfig-core/src/synfig/importer.h
index 30ec899..ce89da5 100644
--- a/synfig-core/src/synfig/importer.h
+++ b/synfig-core/src/synfig/importer.h
@@ -52,7 +52,8 @@
 //! Sets the CVS ID of the importer.
 #define SYNFIG_IMPORTER_SET_CVS_ID(class,x) const char class::cvs_id__[]=x
 
-//! Defines de implementation of the create method for the importer.
+//! Defines de implementation of the create method for the importer
+//! \param filename The file name to be imported by the importer.
 #define SYNFIG_IMPORTER_INIT(class) synfig::Importer* class::create(const char *filename) { return new class(filename); }
 
 /* === T Y P E D E F S ===================================================== */
@@ -69,16 +70,18 @@ class ProgressCallback;
 *
 *	It is the base class for all the importers. It defines the has a static Book
 *	pointer class that is a map for the importers factory creators and the strings
-*	of the importers class names. It allows to create the a pointer to a particular
-*	importer just by using the string of the name of the importer.
-*	Also it creates a virtual member get_frame that must be declared in the inherited
-*	classes.
-*
+*	of the extension that the importer can understand. It allows to create the a
+*	pointer to a particular importer just by using the extension of the name of file
+*	to import. Also it creates a virtual member get_frame that must be declared in
+*	the inherited classes.
+*	\see module.h
 **	\
 */
 class Importer : public etl::shared_object
 {
 public:
+	//! Type that represents a pointer to a Importer's constructor.
+	//! As a pointer to the constructor, it represents a "factory" of importers.
 	typedef Importer* (*Factory)(const char *filename);
 	typedef std::map<String,Factory> Book;
 	static Book* book_;
@@ -97,7 +100,7 @@ public:
 	typedef etl::handle<const Importer> ConstHandle;
 
 private:
-	//! Gamm of the imoporter.
+	//! Gamma of the importer.
 	//! \todo Do not hardcode the gamma to 2.2
 	Gamma gamma_;