summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorElvis Kuliiev <ekuliiev@luxoft.com>2018-05-22 14:06:31 +0300
committerElvis Kuliiev <ekuliiev@luxoft.com>2018-05-22 14:06:31 +0300
commitcc926afbecc315752ec8c768ae357462a2eb4084 (patch)
tree311d576ec2daf5b62b517001e297824e315bf20e
parentcf144fc1509f8baf77496d181b91791a2f5e3380 (diff)
downloadsdl_core-cc926afbecc315752ec8c768ae357462a2eb4084.tar.gz
Review issues: add missing function descriptions
-rw-r--r--src/components/application_manager/include/application_manager/application_impl.h5
-rw-r--r--src/components/application_manager/include/application_manager/hmi_state.h13
-rw-r--r--src/components/application_manager/include/application_manager/state_controller_impl.h14
3 files changed, 32 insertions, 0 deletions
diff --git a/src/components/application_manager/include/application_manager/application_impl.h b/src/components/application_manager/include/application_manager/application_impl.h
index 70f2f49dad..e033570435 100644
--- a/src/components/application_manager/include/application_manager/application_impl.h
+++ b/src/components/application_manager/include/application_manager/application_impl.h
@@ -267,6 +267,11 @@ class ApplicationImpl : public virtual Application,
*/
bool IsAudioApplication() const OVERRIDE;
+ /**
+ * @brief Checks whether the application is navigation or projection
+ *
+ * @return true if application is navigation or projection
+ */
bool IsVideoApplication() const OVERRIDE;
/**
diff --git a/src/components/application_manager/include/application_manager/hmi_state.h b/src/components/application_manager/include/application_manager/hmi_state.h
index af486d6383..22af0bdf5e 100644
--- a/src/components/application_manager/include/application_manager/hmi_state.h
+++ b/src/components/application_manager/include/application_manager/hmi_state.h
@@ -414,7 +414,20 @@ class EmbeddedNavi : public HmiState {
}
};
+/**
+ * @brief Outputs StateID to ostream in human readable format
+ * @param os output stream to insert data to
+ * @param src StateID value to output
+ * @return os
+ */
std::ostream& operator<<(std::ostream& os, const HmiState::StateID src);
+
+/**
+ * @brief Outputs HmiState to ostream in human readable format
+ * @param os output stream to insert data to
+ * @param src HmiState value to output
+ * @return os
+ */
std::ostream& operator<<(std::ostream& os, const HmiState& src);
} // namespace application_manager
diff --git a/src/components/application_manager/include/application_manager/state_controller_impl.h b/src/components/application_manager/include/application_manager/state_controller_impl.h
index 8328897221..61232c842c 100644
--- a/src/components/application_manager/include/application_manager/state_controller_impl.h
+++ b/src/components/application_manager/include/application_manager/state_controller_impl.h
@@ -421,10 +421,24 @@ class StateControllerImpl : public event_engine::EventObserver,
HmiStatePtr CreateHmiState(utils::SharedPtr<Application> app,
HmiState::StateID state_id) const;
+ /**
+ * @brief Determines AudioStreamingState value
+ * for application with HMI level specified.
+ * @param app an application to calculate for
+ * @param hmi_level HMI level
+ * @return AudioStreamingState value
+ */
mobile_apis::AudioStreamingState::eType CalcAudioState(
ApplicationSharedPtr app,
const mobile_apis::HMILevel::eType hmi_level) const;
+ /**
+ * @brief Determines VideoStreamingState value
+ * for application with HMI level specified.
+ * @param app an application to calculate for
+ * @param hmi_level HMI level
+ * @return VideoStreamingState value
+ */
mobile_apis::VideoStreamingState::eType CalcVideoState(
ApplicationSharedPtr app,
const mobile_apis::HMILevel::eType hmi_level) const;