X-Git-Url: https://git.pterodactylus.net/?a=blobdiff_plain;f=synfig-core%2Fsrc%2Fsynfig%2Fimporter.h;h=6185ab5bb5241c23abb3aef4229d147330e65fb8;hb=ccde400e7d43c5cab4c49f4455bc90415c912bea;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..6185ab5 100644
--- a/synfig-core/src/synfig/importer.h
+++ b/synfig-core/src/synfig/importer.h
@@ -38,7 +38,9 @@
 
 //! Defines various variables and the create method, common for all importers.
 //! To be used in the private part of the importer class definition.
-#define SYNFIG_IMPORTER_MODULE_EXT public: static const char name__[], version__[], ext__[],cvs_id__[]; static Importer *create(const char *filename);
+#define SYNFIG_IMPORTER_MODULE_EXT \
+		public: static const char name__[], version__[], ext__[],cvs_id__[]; \
+		static Importer *create(const char *filename);
 
 //! Sets the name of the importer.
 #define SYNFIG_IMPORTER_SET_NAME(class,x) const char class::name__[]=x
@@ -52,7 +54,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 +72,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 +102,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_;