Author: Diego Barrios Romero <[email protected]>
Date: Sat Oct 20 14:23:28 2012 +0200
Documentation
---
synfig-core/src/tool/joblistprocessor.h | 4 ++++
synfig-core/src/tool/optionsprocessor.cpp | 2 +-
synfig-core/src/tool/optionsprocessor.h | 15 ++++++++++++++-
3 files changed, 19 insertions(+), 2 deletions(-)
diff --git a/synfig-core/src/tool/joblistprocessor.h
b/synfig-core/src/tool/joblistprocessor.h
index 9f16c27..60edc56 100644
--- a/synfig-core/src/tool/joblistprocessor.h
+++ b/synfig-core/src/tool/joblistprocessor.h
@@ -25,11 +25,15 @@
#ifndef __SYNFIG_JOBLISTPROCESSOR_H
#define __SYNFIG_JOBLISTPROCESSOR_H
+/// Process a Job list setting up and processing each job
void process_job_list(std::list<Job>& job_list,
const TargetParam&
target_parameters) throw (SynfigToolException&);
+/// Prepare a job to be processed
+/// \return whether the preparation was OK or not
bool setup_job(Job& job, const TargetParam& target_parameters);
+/// Process an individual job
void process_job(Job& job) throw (SynfigToolException&);
#endif // __SYNFIG_JOBLISTPROCESSOR_H
diff --git a/synfig-core/src/tool/optionsprocessor.cpp
b/synfig-core/src/tool/optionsprocessor.cpp
index b4efd2a..fb26195 100644
--- a/synfig-core/src/tool/optionsprocessor.cpp
+++ b/synfig-core/src/tool/optionsprocessor.cpp
@@ -288,7 +288,7 @@ void OptionsProcessor::process_info_options() throw
(SynfigToolException&)
}
}
-RendDesc OptionsProcessor::extract_renddesc(RendDesc& renddesc)
+RendDesc OptionsProcessor::extract_renddesc(const RendDesc& renddesc)
{
RendDesc desc = renddesc;
int w, h;
diff --git a/synfig-core/src/tool/optionsprocessor.h
b/synfig-core/src/tool/optionsprocessor.h
index 0ed2e56..f0949f2 100644
--- a/synfig-core/src/tool/optionsprocessor.h
+++ b/synfig-core/src/tool/optionsprocessor.h
@@ -25,6 +25,7 @@
#ifndef __SYNFIG_OPTIONSPROCESSOR_H
#define __SYNFIG_OPTIONSPROCESSOR_H
+/// Class to process all the command line options
class OptionsProcessor
{
public:
@@ -36,16 +37,28 @@ public:
void process_debug_options() throw (SynfigToolException&);
#endif
+ /// Settings options
+ /// verbose, quiet, threads, benchmarks
void process_settings_options();
+ /// Information options
+ /// Options that will only display information
void process_info_options() throw (SynfigToolException&);
+ /// Extract the necessary options to create a job
+ /// After this, it is necessary to overwrite the necessary RendDesc
options
+ /// and set the target parameters, if provided. Then can be processed
Job extract_job() throw (SynfigToolException&);
- synfig::RendDesc extract_renddesc(synfig::RendDesc& renddesc);
+ /// Overwrite the input RendDesc object with the options given in the
command line
+ synfig::RendDesc extract_renddesc(const synfig::RendDesc& renddesc);
+ /// Extract the target parameters from the options given in the command
line
+ /// video-codec, bitrate, sequence-separator
synfig::TargetParam extract_targetparam() throw (SynfigToolException&);
private:
+ /// Determine which parameters to show in the canvas info
+ /// canvas-info
void extract_canvas_info(Job& job);
boost::program_options::variables_map _vm;
------------------------------------------------------------------------------
Everyone hates slow websites. So do we.
Make your web apps faster with AppDynamics
Download AppDynamics Lite for free today:
http://p.sf.net/sfu/appdyn_sfd2d_oct
_______________________________________________
Synfig-devl mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/synfig-devl
