Module: synfig Branch: genete_core_review Commit: 52a41ca116b89d7393ffe3d21b4ee3845cbe4d1c URL: http://synfig.git.sourceforge.net/git/gitweb.cgi?p=synfig;a=commit;h=52a41ca116b89d7393ffe3d21b4ee3845cbe4d1c
Author: Carlos Lopez <[email protected]> Date: Thu Jun 10 21:33:53 2010 +0200 More code comment --- synfig-core/src/synfig/importer.cpp | 2 +- synfig-core/src/synfig/importer.h | 13 +++++++------ 2 files changed, 8 insertions(+), 7 deletions(-) diff --git a/synfig-core/src/synfig/importer.cpp b/synfig-core/src/synfig/importer.cpp index e271110..7002638 100644 --- a/synfig-core/src/synfig/importer.cpp +++ b/synfig-core/src/synfig/importer.cpp @@ -1,6 +1,6 @@ /* === S Y N F I G ========================================================= */ /*! \file importer.cpp -** \brief writeme +** \brief It is the base class for all the importers. ** ** $Id$ ** diff --git a/synfig-core/src/synfig/importer.h b/synfig-core/src/synfig/importer.h index 30ec899..18c53a4 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,11 +70,11 @@ 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 ------------------------------------------------------------------------------ ThinkGeek and WIRED's GeekDad team up for the Ultimate GeekDad Father's Day Giveaway. ONE MASSIVE PRIZE to the lucky parental unit. See the prize list and enter to win: http://p.sf.net/sfu/thinkgeek-promo _______________________________________________ Synfig-devl mailing list [email protected] https://lists.sourceforge.net/lists/listinfo/synfig-devl
