diff options
| author | Carl Hetherington <cth@carlh.net> | 2017-03-02 15:37:13 +0000 |
|---|---|---|
| committer | Carl Hetherington <cth@carlh.net> | 2017-04-19 23:04:32 +0100 |
| commit | 67a68bd971ebe1b35daa3f75873b4ccb53c00ba0 (patch) | |
| tree | 9b1fea4070c3b15f346cc57075bbeed1b963329d /src/lib | |
| parent | 3449bc0a6d6e77e851240a0953363f5a07ec6517 (diff) | |
Various Doxygen fixes.
Diffstat (limited to 'src/lib')
36 files changed, 114 insertions, 61 deletions
diff --git a/src/lib/audio_buffers.cc b/src/lib/audio_buffers.cc index aea581a07..825c6c2f3 100644 --- a/src/lib/audio_buffers.cc +++ b/src/lib/audio_buffers.cc @@ -224,6 +224,9 @@ AudioBuffers::move (int32_t frames, int32_t from, int32_t to) } /** Add data from from `from', `from_channel' to our channel `to_channel'. + * @param from Buffers to copy data from. + * @param from_channel Channel index to read in \p from. + * @param to_channel Channel index to accumulate into. * @param gain Linear gain to apply to the data before it is added. */ void diff --git a/src/lib/audio_buffers.h b/src/lib/audio_buffers.h index 991ef5334..f4a0c1f1c 100644 --- a/src/lib/audio_buffers.h +++ b/src/lib/audio_buffers.h @@ -32,7 +32,7 @@ * @brief A class to hold multi-channel audio data in float format. * * The use of int32_t for frame counts in this class is due to the - * round-up to the next power-of-2 code in ::ensure_size; if that + * round-up to the next power-of-2 code in ensure_size(); if that * were changed the frame count could use any integer type. */ class AudioBuffers diff --git a/src/lib/cinema_kdms.cc b/src/lib/cinema_kdms.cc index 8cac65f41..605e414a0 100644 --- a/src/lib/cinema_kdms.cc +++ b/src/lib/cinema_kdms.cc @@ -178,6 +178,10 @@ CinemaKDMs::write_zip_files ( } /** Email one ZIP file per cinema to the cinema. + * @param cinema_kdms KDMS to email. + * @param name_format Format of filename to use. + * @param name_values Values to substitute into \p name_format. + * @param cpl_name Name of the CPL that the KDMs are for. * @param log Log to write email session transcript to, or 0. */ void diff --git a/src/lib/config.h b/src/lib/config.h index 80dfb1dc9..ed29a8f24 100644 --- a/src/lib/config.h +++ b/src/lib/config.h @@ -550,7 +550,7 @@ public: void changed (Property p = OTHER); boost::signals2::signal<void (Property)> Changed; - /** Emitted if ::read() failed on an existing Config file. There is nothing + /** Emitted if read() failed on an existing Config file. There is nothing a listener can do about it: this is just for information. */ static boost::signals2::signal<void ()> FailedToLoad; diff --git a/src/lib/content.h b/src/lib/content.h index 519ff8907..334a82756 100644 --- a/src/lib/content.h +++ b/src/lib/content.h @@ -121,7 +121,7 @@ public: /** @return Digest of the content's file(s). Note: this is * not a complete MD5-or-whatever hash, but a sort of poor - * man's version (see comments in ::examine). + * man's version (see comments in examine()). */ std::string digest () const { boost::mutex::scoped_lock lm (_mutex); diff --git a/src/lib/cross.h b/src/lib/cross.h index c7bb4991c..9fac7e643 100644 --- a/src/lib/cross.h +++ b/src/lib/cross.h @@ -53,7 +53,7 @@ extern uint64_t thread_id (); /** @class Waker * @brief A class which tries to keep the computer awake on various operating systems. * - * Create a Waker to prevent sleep, and call ::nudge every so often (every minute or so). + * Create a Waker to prevent sleep, and call nudge() every so often (every minute or so). * Destroy the Waker to allow sleep again. */ class Waker diff --git a/src/lib/dcp_video.cc b/src/lib/dcp_video.cc index 5fbe6d169..ba8057be0 100644 --- a/src/lib/dcp_video.cc +++ b/src/lib/dcp_video.cc @@ -148,6 +148,7 @@ DCPVideo::encode_locally (dcp::NoteHandler note) /** Send this frame to a remote server for J2K encoding, then read the result. * @param serv Server to send to. + * @param timeout timeout in seconds. * @return Encoded data. */ Data diff --git a/src/lib/dcpomatic_socket.cc b/src/lib/dcpomatic_socket.cc index fa06918d4..ca910bb79 100644 --- a/src/lib/dcpomatic_socket.cc +++ b/src/lib/dcpomatic_socket.cc @@ -27,6 +27,7 @@ #include "i18n.h" +/** @param timeout Timeout in seconds */ Socket::Socket (int timeout) : _deadline (_io_service) , _socket (_io_service) diff --git a/src/lib/dcpomatic_time.h b/src/lib/dcpomatic_time.h index cc31755cb..8b2bcce05 100644 --- a/src/lib/dcpomatic_time.h +++ b/src/lib/dcpomatic_time.h @@ -158,7 +158,13 @@ public: return ::ceil (_t * double(r) / HZ); } - /** @param r Frames per second */ + /** Split a time into hours, minutes, seconds and frames. + * @param r Frames per second. + * @param h Returned hours. + * @param m Returned minutes. + * @param s Returned seconds. + * @param f Returned frames. + */ template <typename T> void split (T r, int& h, int& m, int& s, int& f) const { @@ -292,7 +298,9 @@ public: } }; -/** @param B Periods to subtract from `A', must be in ascending order of start time and must not overlap */ +/** @param A Period which is subtracted from. + * @param B Periods to subtract from `A', must be in ascending order of start time and must not overlap. + */ template <class T> std::list<TimePeriod<T> > subtract (TimePeriod<T> A, std::list<TimePeriod<T> > const & B) { diff --git a/src/lib/encoder.cc b/src/lib/encoder.cc index a9e119d59..e43325f58 100644 --- a/src/lib/encoder.cc +++ b/src/lib/encoder.cc @@ -56,7 +56,9 @@ using dcp::Data; int const Encoder::_history_size = 200; -/** @param f Film that we are encoding */ +/** @param film Film that we are encoding. + * @param writer Writer that we are using. + */ Encoder::Encoder (shared_ptr<const Film> film, shared_ptr<Writer> writer) : _film (film) , _writer (writer) @@ -172,9 +174,7 @@ Encoder::video_frames_enqueued () const return _last_player_video_time->frames_floor (_film->video_frame_rate ()); } -/** Should be called when a frame has been encoded successfully. - * @param n Source frame index. - */ +/** Should be called when a frame has been encoded successfully */ void Encoder::frame_done () { @@ -192,6 +192,9 @@ Encoder::frame_done () * so each time the supplied frame is the one after the previous one. * pv represents one video frame, and could be empty if there is nothing to encode * for this DCP frame. + * + * @param pv PlayerVideo to encode. + * @param time Time of \p pv within the DCP. */ void Encoder::encode (shared_ptr<PlayerVideo> pv, DCPTime time) diff --git a/src/lib/encoder.h b/src/lib/encoder.h index 27ae64aac..fe18f8b2d 100644 --- a/src/lib/encoder.h +++ b/src/lib/encoder.h @@ -55,14 +55,14 @@ class PlayerVideo; class Encoder : public boost::noncopyable, public ExceptionStore, public boost::enable_shared_from_this<Encoder> { public: - Encoder (boost::shared_ptr<const Film>, boost::shared_ptr<Writer>); + Encoder (boost::shared_ptr<const Film> film, boost::shared_ptr<Writer> writer); ~Encoder (); /** Called to indicate that a processing run is about to begin */ void begin (); /** Called to pass a bit of video to be encoded as the next DCP frame */ - void encode (boost::shared_ptr<PlayerVideo> f, DCPTime time); + void encode (boost::shared_ptr<PlayerVideo> pv, DCPTime time); /** Called when a processing run has finished */ void end (); diff --git a/src/lib/exceptions.h b/src/lib/exceptions.h index 99a8c0dc4..c2f82e15b 100644 --- a/src/lib/exceptions.h +++ b/src/lib/exceptions.h @@ -167,7 +167,9 @@ public: class BadSettingError : public SettingError { public: - /** @param s Name of setting that is bad */ + /** @param s Name of setting that is bad. + * @param m Error message. + */ BadSettingError (std::string s, std::string m) : SettingError (s, m) {} diff --git a/src/lib/ffmpeg_subtitle_stream.cc b/src/lib/ffmpeg_subtitle_stream.cc index 62accfaf8..3935e23a9 100644 --- a/src/lib/ffmpeg_subtitle_stream.cc +++ b/src/lib/ffmpeg_subtitle_stream.cc @@ -32,8 +32,8 @@ using std::make_pair; using dcp::raw_convert; /** Construct a SubtitleStream from a value returned from to_string(). - * @param t String returned from to_string(). - * @param v State file version. + * @param node String returned from to_string(). + * @param version State file version. */ FFmpegSubtitleStream::FFmpegSubtitleStream (cxml::ConstNodePtr node, int version) : FFmpegStream (node) diff --git a/src/lib/ffmpeg_subtitle_stream.h b/src/lib/ffmpeg_subtitle_stream.h index 704ac7b79..8b0274a5d 100644 --- a/src/lib/ffmpeg_subtitle_stream.h +++ b/src/lib/ffmpeg_subtitle_stream.h @@ -30,7 +30,7 @@ public: : FFmpegStream (n, i) {} - FFmpegSubtitleStream (cxml::ConstNodePtr, int version); + FFmpegSubtitleStream (cxml::ConstNodePtr node, int version); void as_xml (xmlpp::Node *) const; diff --git a/src/lib/film.cc b/src/lib/film.cc index 56dce56e5..82a40d5c4 100644 --- a/src/lib/film.cc +++ b/src/lib/film.cc @@ -1207,8 +1207,12 @@ Film::frame_size () const return fit_ratio_within (container()->ratio(), full_frame ()); } -/** @param from KDM from time expressed as a local time with an offset from UTC - * @param to KDM to time expressed as a local time with an offset from UTC +/** @param recipient KDM recipient certificate. + * @param trusted_devices Certificates of other trusted devices (can be empty). + * @param cpl_file CPL filename. + * @param from KDM from time expressed as a local time with an offset from UTC. + * @param until KDM to time expressed as a local time with an offset from UTC. + * @param formulation KDM formulation to use. */ dcp::EncryptedKDM Film::make_kdm ( @@ -1267,13 +1271,16 @@ Film::make_kdm ( ).encrypt (signer, recipient, trusted_devices, formulation); } -/** @param from KDM from time expressed as a local time in the time zone of the Screen's Cinema. - * @param to KDM to time expressed as a local time in the time zone of the Screen's Cinema. +/** @param screens Screens to make KDMs for. + * @param cpl_file Path to CPL to make KDMs for. + * @param from KDM from time expressed as a local time in the time zone of the Screen's Cinema. + * @param until KDM to time expressed as a local time in the time zone of the Screen's Cinema. + * @param formulation KDM formulation to use. */ list<ScreenKDM> Film::make_kdms ( list<shared_ptr<Screen> > screens, - boost::filesystem::path dcp, + boost::filesystem::path cpl_file, boost::posix_time::ptime from, boost::posix_time::ptime until, dcp::Formulation formulation @@ -1286,7 +1293,7 @@ Film::make_kdms ( dcp::EncryptedKDM const kdm = make_kdm ( i->recipient.get(), i->trusted_devices, - dcp, + cpl_file, dcp::LocalTime (from, i->cinema->utc_offset_hour(), i->cinema->utc_offset_minute()), dcp::LocalTime (until, i->cinema->utc_offset_hour(), i->cinema->utc_offset_minute()), formulation @@ -1510,6 +1517,9 @@ Film::reels () const return p; } +/** @param period A period within the DCP + * @return Name of the content which most contributes to the given period. + */ string Film::content_summary (DCPTimePeriod period) const { diff --git a/src/lib/film.h b/src/lib/film.h index e8fcb5a45..9f473d711 100644 --- a/src/lib/film.h +++ b/src/lib/film.h @@ -131,7 +131,7 @@ public: ) const; std::list<ScreenKDM> make_kdms ( - std::list<boost::shared_ptr<Screen> >, + std::list<boost::shared_ptr<Screen> > screens, boost::filesystem::path cpl_file, boost::posix_time::ptime from, boost::posix_time::ptime until, @@ -160,9 +160,6 @@ public: std::list<DCPTimePeriod> reels () const; std::list<int> mapped_audio_channels () const; - /** @param A period within the DCP - * @return Name of the content which most contributes to the given period. - */ std::string content_summary (DCPTimePeriod period) const; std::list<std::string> fix_conflicting_settings (); diff --git a/src/lib/filter.h b/src/lib/filter.h index 36e4dfa27..455b271a2 100644 --- a/src/lib/filter.h +++ b/src/lib/filter.h @@ -39,7 +39,7 @@ class Filter : public boost::noncopyable { public: - Filter (std::string, std::string, std::string, std::string); + Filter (std::string i, std::string n, std::string c, std::string f); /** @return our id */ std::string id () const { @@ -61,9 +61,9 @@ public: } static std::vector<Filter const *> all (); - static Filter const * from_id (std::string); + static Filter const * from_id (std::string d); static void setup_filters (); - static std::string ffmpeg_string (std::vector<Filter const *> const &); + static std::string ffmpeg_string (std::vector<Filter const *> const & filters); private: diff --git a/src/lib/filter_graph.cc b/src/lib/filter_graph.cc index 7a2973815..2fb1ad187 100644 --- a/src/lib/filter_graph.cc +++ b/src/lib/filter_graph.cc @@ -47,11 +47,7 @@ using boost::shared_ptr; using boost::weak_ptr; using dcp::Size; -/** Construct a FilterGraph for the settings in a piece of content. - * @param content Content. - * @param s Size of the images to process. - * @param p Pixel format of the images to process. - */ +/** Construct a FilterGraph for the settings in a piece of content */ FilterGraph::FilterGraph () : _graph (0) , _copy (false) diff --git a/src/lib/image.cc b/src/lib/image.cc index 13ef0db19..8718223ae 100644 --- a/src/lib/image.cc +++ b/src/lib/image.cc @@ -103,6 +103,12 @@ Image::planes () const } /** Crop this image, scale it to `inter_size' and then place it in a black frame of `out_size'. + * @param crop Amount to crop by. + * @param inter_size Size to scale the cropped image to. + * @param out_size Size of output frame; if this is larger than inter_size there will be black padding. + * @param yuv_to_rgb YUV to RGB transformation to use, if required. + * @param out_format Output pixel format. + * @param out_aligned true to make the output image aligned. * @param fast Try to be fast at the possible expense of quality; at present this means using * fast bilinear rather than bicubic scaling. */ @@ -208,7 +214,11 @@ Image::crop_scale_window ( return out; } -/** @param fast Try to be fast at the possible expense of quality; at present this means using +/** @param out_size Size to scale to. + * @param yuv_to_rgb YUVToRGB transform transform to use, if required. + * @param out_format Output pixel format. + * @param out_aligned true to make an aligned output image. + * @param fast Try to be fast at the possible expense of quality; at present this means using * fast bilinear rather than bicubic scaling. */ shared_ptr<Image> @@ -628,6 +638,7 @@ Image::bytes_per_pixel (int c) const * * @param p Pixel format. * @param s Size in pixels. + * @param aligned true to make each row of this image aligned to a 32-byte boundary. * @param extra_pixels Amount of extra "run-off" memory to allocate at the end of each plane in pixels. */ Image::Image (AVPixelFormat p, dcp::Size s, bool aligned, int extra_pixels) diff --git a/src/lib/image.h b/src/lib/image.h index c5fc3dd2d..84871aae2 100644 --- a/src/lib/image.h +++ b/src/lib/image.h @@ -40,7 +40,7 @@ class Socket; class Image { public: - Image (AVPixelFormat, dcp::Size, bool, int extra_pixels = 0); + Image (AVPixelFormat p, dcp::Size s, bool aligned, int extra_pixels = 0); Image (AVFrame *); Image (Image const &); Image (boost::shared_ptr<const Image>, bool); @@ -57,10 +57,10 @@ public: int line_factor (int) const; dcp::Size sample_size (int) const; - boost::shared_ptr<Image> scale (dcp::Size, dcp::YUVToRGB yuv_to_rgb, AVPixelFormat, bool aligned, bool fast) const; + boost::shared_ptr<Image> scale (dcp::Size out_size, dcp::YUVToRGB yuv_to_rgb, AVPixelFormat out_format, bool aligned, bool fast) const; boost::shared_ptr<Image> crop_scale_window ( - Crop c, dcp::Size, dcp::Size, dcp::YUVToRGB yuv_to_rgb, AVPixelFormat, bool aligned, bool fast) - const; + Crop crop, dcp::Size inter_size, dcp::Size out_size, dcp::YUVToRGB yuv_to_rgb, AVPixelFormat out_format, bool aligned, bool fast + ) const; void make_black (); void make_transparent (); diff --git a/src/lib/job.cc b/src/lib/job.cc index dacc8bf31..31f336b65 100644 --- a/src/lib/job.cc +++ b/src/lib/job.cc @@ -302,6 +302,7 @@ Job::check_for_interruption_or_pause () /** Set the progress of the current part of the job. * @param p Progress (from 0 to 1) + * @param force Do not ignore this update, even if it hasn't been long since the last one. */ void Job::set_progress (float p, bool force) @@ -374,7 +375,8 @@ Job::error_summary () const } /** Set the current error string. - * @param e New error string. + * @param s New error string. + * @param d New error detail string. */ void Job::set_error (string s, string d) diff --git a/src/lib/job.h b/src/lib/job.h index 311f9cc91..185273e2d 100644 --- a/src/lib/job.h +++ b/src/lib/job.h @@ -40,7 +40,7 @@ class Film; class Job : public boost::enable_shared_from_this<Job>, public Signaller, public boost::noncopyable { public: - Job (boost::shared_ptr<const Film>); + Job (boost::shared_ptr<const Film> film); virtual ~Job (); /** @return user-readable name of this job */ diff --git a/src/lib/player_video.cc b/src/lib/player_video.cc index b7fb52e3a..2e53a6aa6 100644 --- a/src/lib/player_video.cc +++ b/src/lib/player_video.cc @@ -99,6 +99,8 @@ PlayerVideo::set_subtitle (PositionImage image) * @param pixel_format Function which is called to decide what pixel format the output image should be; * it is passed the pixel format of the input image from the ImageProxy, and should return the desired * output pixel format. Two functions always_rgb and keep_xyz_or_rgb are provided for use here. + * @param aligned true if the output image should be aligned to 32-byte boundaries. + * @param fast true to be fast at the expense of quality. */ shared_ptr<Image> PlayerVideo::image (dcp::NoteHandler note, function<AVPixelFormat (AVPixelFormat)> pixel_format, bool aligned, bool fast) const diff --git a/src/lib/playlist.cc b/src/lib/playlist.cc index 6abbbcab3..aa365ead4 100644 --- a/src/lib/playlist.cc +++ b/src/lib/playlist.cc @@ -159,7 +159,11 @@ Playlist::video_identifier () const return digester.get (); } -/** @param node <Playlist> node */ +/** @param film Film that this Playlist is for. + * @param node <Playlist> node. + * @param version Metadata version number. + * @param notes Output notes about that happened. + */ void Playlist::set_from_xml (shared_ptr<const Film> film, cxml::ConstNodePtr node, int version, list<string>& notes) { @@ -173,7 +177,9 @@ Playlist::set_from_xml (shared_ptr<const Film> film, cxml::ConstNodePtr node, in reconnect (); } -/** @param node <Playlist> node */ +/** @param node <Playlist> node. + * @param with_content_paths true to include <Path> nodes in <Content> nodes, false to omit them. + */ void Playlist::as_xml (xmlpp::Node* node, bool with_content_paths) { diff --git a/src/lib/playlist.h b/src/lib/playlist.h index 335e26013..0b19a6e44 100644 --- a/src/lib/playlist.h +++ b/src/lib/playlist.h @@ -46,7 +46,7 @@ public: ~Playlist (); void as_xml (xmlpp::Node *, bool with_content_paths); - void set_from_xml (boost::shared_ptr<const Film>, cxml::ConstNodePtr, int, std::list<std::string> &); + void set_from_xml (boost::shared_ptr<const Film> film, cxml::ConstNodePtr node, int version, std::list<std::string>& notes); void add (boost::shared_ptr<Content>); void remove (boost::shared_ptr<Content>); diff --git a/src/lib/scoped_temporary.cc b/src/lib/scoped_temporary.cc index 3503808bc..5c885e4df 100644 --- a/src/lib/scoped_temporary.cc +++ b/src/lib/scoped_temporary.cc @@ -21,7 +21,7 @@ #include "scoped_temporary.h" /** Construct a ScopedTemporary. A temporary filename is decided but the file is not opened - * until ::open() is called. + * until open() is called. */ ScopedTemporary::ScopedTemporary () : _open (0) diff --git a/src/lib/send_kdm_email_job.cc b/src/lib/send_kdm_email_job.cc index 642939462..890115747 100644 --- a/src/lib/send_kdm_email_job.cc +++ b/src/lib/send_kdm_email_job.cc @@ -30,7 +30,12 @@ using std::string; using std::list; using boost::shared_ptr; -/** @param log Log to write to, or 0 */ +/** @param cinema_kdms KDMs to email. + * @param name_format Format to use for filenames. + * @param name_values Values to substitute into the filenames. + * @param cpl_name Name of the CPL that the KDMs are for. + * @param log Log to write to, or 0. + */ SendKDMEmailJob::SendKDMEmailJob ( list<CinemaKDMs> cinema_kdms, dcp::NameFormat name_format, diff --git a/src/lib/send_problem_report_job.cc b/src/lib/send_problem_report_job.cc index c8b577ca7..aac2b6e66 100644 --- a/src/lib/send_problem_report_job.cc +++ b/src/lib/send_problem_report_job.cc @@ -36,7 +36,10 @@ using std::string; using std::list; using boost::shared_ptr; -/** @param film Film thta the problem is with, or 0 */ +/** @param film Film thta the problem is with, or 0. + * @param from Email address to use for From: + * @param summary Summary of the problem. + */ SendProblemReportJob::SendProblemReportJob ( shared_ptr<const Film> film, string from, diff --git a/src/lib/send_problem_report_job.h b/src/lib/send_problem_report_job.h index ff787852e..c4371a54e 100644 --- a/src/lib/send_problem_report_job.h +++ b/src/lib/send_problem_report_job.h @@ -26,7 +26,7 @@ class SendProblemReportJob : public Job { public: SendProblemReportJob ( - boost::shared_ptr<const Film>, + boost::shared_ptr<const Film> film, std::string from, std::string summary ); diff --git a/src/lib/subtitle_decoder.h b/src/lib/subtitle_decoder.h index 2b38153bf..6d0479638 100644 --- a/src/lib/subtitle_decoder.h +++ b/src/lib/subtitle_decoder.h @@ -52,8 +52,8 @@ public: return _position; } - void emit_image (ContentTimePeriod period, boost::shared_ptr<Image>, dcpomatic::Rect<double>); - void emit_text (ContentTimePeriod period, std::list<dcp::SubtitleString>); + void emit_image (ContentTimePeriod period, boost::shared_ptr<Image> image, dcpomatic::Rect<double> rect); + void emit_text (ContentTimePeriod period, std::list<dcp::SubtitleString> s); void emit_text (ContentTimePeriod period, sub::Subtitle const & subtitle); boost::shared_ptr<const SubtitleContent> content () const { diff --git a/src/lib/transcode_job.cc b/src/lib/transcode_job.cc index 79b5b1739..17108c278 100644 --- a/src/lib/transcode_job.cc +++ b/src/lib/transcode_job.cc @@ -44,8 +44,7 @@ using std::setprecision; using std::cout; using boost::shared_ptr; -/** @param s Film to use. - */ +/** @param film Film to use */ TranscodeJob::TranscodeJob (shared_ptr<const Film> film) : Job (film) { diff --git a/src/lib/transcode_job.h b/src/lib/transcode_job.h index 5419a46f3..14ad693c3 100644 --- a/src/lib/transcode_job.h +++ b/src/lib/transcode_job.h @@ -33,7 +33,7 @@ class Transcoder; class TranscodeJob : public Job { public: - TranscodeJob (boost::shared_ptr<const Film>); + TranscodeJob (boost::shared_ptr<const Film> film); std::string name () const; std::string json_name () const; diff --git a/src/lib/transcoder.cc b/src/lib/transcoder.cc index de2fb1d33..21ef60b79 100644 --- a/src/lib/transcoder.cc +++ b/src/lib/transcoder.cc @@ -51,14 +51,14 @@ using boost::weak_ptr; using boost::dynamic_pointer_cast; /** Construct a transcoder. - * @param f Film that we are transcoding. - * @param j Job that this transcoder is being used in. + * @param film Film that we are transcoding. + * @param job Job that this transcoder is being used in. */ -Transcoder::Transcoder (shared_ptr<const Film> film, weak_ptr<Job> j) +Transcoder::Transcoder (shared_ptr<const Film> film, weak_ptr<Job> job) : _film (film) - , _job (j) + , _job (job) , _player (new Player (film, film->playlist ())) - , _writer (new Writer (film, j)) + , _writer (new Writer (film, job)) , _encoder (new Encoder (film, _writer)) , _finishing (false) , _non_burnt_subtitles (false) diff --git a/src/lib/transcoder.h b/src/lib/transcoder.h index 0095ad9d1..50cbfdfec 100644 --- a/src/lib/transcoder.h +++ b/src/lib/transcoder.h @@ -34,7 +34,7 @@ class AudioBuffers; class Transcoder : public boost::noncopyable { public: - Transcoder (boost::shared_ptr<const Film>, boost::weak_ptr<Job>); + Transcoder (boost::shared_ptr<const Film> film, boost::weak_ptr<Job> job); void go (); diff --git a/src/lib/util.cc b/src/lib/util.cc index 38770f4e3..574d1d889 100644 --- a/src/lib/util.cc +++ b/src/lib/util.cc @@ -462,7 +462,7 @@ digest_head_tail (vector<boost::filesystem::path> files, boost::uintmax_t size) /** Round a number up to the nearest multiple of another number. * @param c Index. - * @param s Array of numbers to round, indexed by c. + * @param stride Array of numbers to round, indexed by c. * @param t Multiple to round to. * @return Rounded number. */ diff --git a/src/lib/writer.h b/src/lib/writer.h index 14b21f359..2a78637e5 100644 --- a/src/lib/writer.h +++ b/src/lib/writer.h @@ -82,7 +82,7 @@ bool operator== (QueueItem const & a, QueueItem const & b); * or AudioBuffers objects (containing image or sound data respectively) * and writes them to the assets. * - * ::write() for Data (picture) can be called out of order, and the Writer + * write() for Data (picture) can be called out of order, and the Writer * will sort it out. write() for AudioBuffers must be called in order. */ |
