From 3b8dd28d349c28eacfde2a87ff7f8280b23d5c14 Mon Sep 17 00:00:00 2001 From: Taner Sener Date: Sat, 17 Sep 2022 20:59:50 +0100 Subject: [PATCH] update apple and linux doc warnings --- apple/src/FFmpegSession.h | 4 ++++ apple/src/FFprobeSession.h | 4 ++++ apple/src/MediaInformationSession.h | 3 +++ linux/src/FFmpegSession.h | 4 ++++ linux/src/FFprobeSession.h | 4 ++++ linux/src/MediaInformationSession.h | 3 +++ 6 files changed, 22 insertions(+) diff --git a/apple/src/FFmpegSession.h b/apple/src/FFmpegSession.h index f877d34..3523410 100644 --- a/apple/src/FFmpegSession.h +++ b/apple/src/FFmpegSession.h @@ -34,6 +34,7 @@ * Builds a new FFmpeg session. * * @param arguments command arguments + * @return created session */ + (instancetype)create:(NSArray*)arguments; @@ -42,6 +43,7 @@ * * @param arguments command arguments * @param completeCallback session specific complete callback + * @return created session */ + (instancetype)create:(NSArray*)arguments withCompleteCallback:(FFmpegSessionCompleteCallback)completeCallback; @@ -52,6 +54,7 @@ * @param completeCallback session specific complete callback * @param logCallback session specific log callback * @param statisticsCallback session specific statistics callback + * @return created session */ + (instancetype)create:(NSArray*)arguments withCompleteCallback:(FFmpegSessionCompleteCallback)completeCallback withLogCallback:(LogCallback)logCallback withStatisticsCallback:(StatisticsCallback)statisticsCallback; @@ -63,6 +66,7 @@ * @param logCallback session specific log callback * @param statisticsCallback session specific statistics callback * @param logRedirectionStrategy session specific log redirection strategy + * @return created session */ + (instancetype)create:(NSArray*)arguments withCompleteCallback:(FFmpegSessionCompleteCallback)completeCallback withLogCallback:(LogCallback)logCallback withStatisticsCallback:(StatisticsCallback)statisticsCallback withLogRedirectionStrategy:(LogRedirectionStrategy)logRedirectionStrategy; diff --git a/apple/src/FFprobeSession.h b/apple/src/FFprobeSession.h index f09dbe6..490e7f2 100644 --- a/apple/src/FFprobeSession.h +++ b/apple/src/FFprobeSession.h @@ -33,6 +33,7 @@ * Builds a new FFprobe session. * * @param arguments command arguments + * @return created session */ + (instancetype)create:(NSArray*)arguments; @@ -41,6 +42,7 @@ * * @param arguments command arguments * @param completeCallback session specific complete callback + * @return created session */ + (instancetype)create:(NSArray*)arguments withCompleteCallback:(FFprobeSessionCompleteCallback)completeCallback; @@ -50,6 +52,7 @@ * @param arguments command arguments * @param completeCallback session specific complete callback * @param logCallback session specific log callback + * @return created session */ + (instancetype)create:(NSArray*)arguments withCompleteCallback:(FFprobeSessionCompleteCallback)completeCallback withLogCallback:(LogCallback)logCallback; @@ -60,6 +63,7 @@ * @param completeCallback session specific complete callback * @param logCallback session specific log callback * @param logRedirectionStrategy session specific log redirection strategy + * @return created session */ + (instancetype)create:(NSArray*)arguments withCompleteCallback:(FFprobeSessionCompleteCallback)completeCallback withLogCallback:(LogCallback)logCallback withLogRedirectionStrategy:(LogRedirectionStrategy)logRedirectionStrategy; diff --git a/apple/src/MediaInformationSession.h b/apple/src/MediaInformationSession.h index 5df4ace..6a070ec 100644 --- a/apple/src/MediaInformationSession.h +++ b/apple/src/MediaInformationSession.h @@ -35,6 +35,7 @@ * Creates a new media information session. * * @param arguments command arguments + * @return created session */ + (instancetype)create:(NSArray*)arguments; @@ -43,6 +44,7 @@ * * @param arguments command arguments * @param completeCallback session specific complete callback + * @return created session */ + (instancetype)create:(NSArray*)arguments withCompleteCallback:(MediaInformationSessionCompleteCallback)completeCallback; @@ -52,6 +54,7 @@ * @param arguments command arguments * @param completeCallback session specific complete callback * @param logCallback session specific log callback + * @return created session */ + (instancetype)create:(NSArray*)arguments withCompleteCallback:(MediaInformationSessionCompleteCallback)completeCallback withLogCallback:(LogCallback)logCallback; diff --git a/linux/src/FFmpegSession.h b/linux/src/FFmpegSession.h index a684833..e9cfed6 100644 --- a/linux/src/FFmpegSession.h +++ b/linux/src/FFmpegSession.h @@ -36,6 +36,7 @@ namespace ffmpegkit { * Builds a new FFmpeg session. * * @param arguments command arguments + * @return created session */ static std::shared_ptr create(const std::list& arguments); @@ -44,6 +45,7 @@ namespace ffmpegkit { * * @param arguments command arguments * @param completeCallback session specific complete callback + * @return created session */ static std::shared_ptr create(const std::list& arguments, ffmpegkit::FFmpegSessionCompleteCallback completeCallback); @@ -54,6 +56,7 @@ namespace ffmpegkit { * @param completeCallback session specific complete callback * @param logCallback session specific log callback * @param statisticsCallback session specific statistics callback + * @return created session */ static std::shared_ptr create(const std::list& arguments, ffmpegkit::FFmpegSessionCompleteCallback completeCallback, ffmpegkit::LogCallback logCallback, ffmpegkit::StatisticsCallback statisticsCallback); @@ -65,6 +68,7 @@ namespace ffmpegkit { * @param logCallback session specific log callback * @param statisticsCallback session specific statistics callback * @param logRedirectionStrategy session specific log redirection strategy + * @return created session */ static std::shared_ptr create(const std::list& arguments, ffmpegkit::FFmpegSessionCompleteCallback completeCallback, ffmpegkit::LogCallback logCallback, ffmpegkit::StatisticsCallback statisticsCallback, ffmpegkit::LogRedirectionStrategy logRedirectionStrategy); diff --git a/linux/src/FFprobeSession.h b/linux/src/FFprobeSession.h index 381747b..53c6814 100644 --- a/linux/src/FFprobeSession.h +++ b/linux/src/FFprobeSession.h @@ -35,6 +35,7 @@ namespace ffmpegkit { * Builds a new FFprobe session. * * @param arguments command arguments + * @return created session */ static std::shared_ptr create(const std::list& arguments); @@ -43,6 +44,7 @@ namespace ffmpegkit { * * @param arguments command arguments * @param completeCallback session specific complete callback + * @return created session */ static std::shared_ptr create(const std::list& arguments, const FFprobeSessionCompleteCallback completeCallback); @@ -52,6 +54,7 @@ namespace ffmpegkit { * @param arguments command arguments * @param completeCallback session specific complete callback * @param logCallback session specific log callback + * @return created session */ static std::shared_ptr create(const std::list& arguments, const FFprobeSessionCompleteCallback completeCallback, const ffmpegkit::LogCallback logCallback); @@ -62,6 +65,7 @@ namespace ffmpegkit { * @param completeCallback session specific complete callback * @param logCallback session specific log callback * @param logRedirectionStrategy session specific log redirection strategy + * @return created session */ static std::shared_ptr create(const std::list& arguments, const FFprobeSessionCompleteCallback completeCallback, const ffmpegkit::LogCallback logCallback, const LogRedirectionStrategy logRedirectionStrategy); diff --git a/linux/src/MediaInformationSession.h b/linux/src/MediaInformationSession.h index b59a01d..6ec2f10 100644 --- a/linux/src/MediaInformationSession.h +++ b/linux/src/MediaInformationSession.h @@ -37,6 +37,7 @@ namespace ffmpegkit { * Creates a new media information session. * * @param arguments command arguments + * @return created session */ static std::shared_ptr create(const std::list& arguments); @@ -45,6 +46,7 @@ namespace ffmpegkit { * * @param arguments command arguments * @param completeCallback session specific complete callback + * @return created session */ static std::shared_ptr create(const std::list& arguments, ffmpegkit::MediaInformationSessionCompleteCallback completeCallback); @@ -54,6 +56,7 @@ namespace ffmpegkit { * @param arguments command arguments * @param completeCallback session specific complete callback * @param logCallback session specific log callback + * @return created session */ static std::shared_ptr create(const std::list& arguments, ffmpegkit::MediaInformationSessionCompleteCallback completeCallback, ffmpegkit::LogCallback logCallback);