diff options
Diffstat (limited to 'src/diagnostic')
| -rw-r--r-- | src/diagnostic/active-diagnostic-request.hpp | 20 | ||||
| -rw-r--r-- | src/diagnostic/diagnostic-message.cpp | 8 |
2 files changed, 14 insertions, 14 deletions
diff --git a/src/diagnostic/active-diagnostic-request.hpp b/src/diagnostic/active-diagnostic-request.hpp index fe237d4b..0a64f7c9 100644 --- a/src/diagnostic/active-diagnostic-request.hpp +++ b/src/diagnostic/active-diagnostic-request.hpp @@ -56,26 +56,26 @@ typedef void (*DiagnosticResponseCallback)(const active_diagnostic_request_t* re */ class active_diagnostic_request_t { private: - can_bus_dev_t* bus_; /*!< can_bus_dev_t* bus_ - The CAN bus this request should be made on, or is currently in flight-on*/ - uint32_t id_; /*!< The arbitration ID (aka message ID) for the request.*/ - DiagnosticRequestHandle* handle_; /*!< DiagnosticRequestHandle* handle - A handle for the request to keep track of it between + can_bus_dev_t* bus_; /*!< bus_ - The CAN bus this request should be made on, or is currently in flight-on*/ + uint32_t id_; /*!< id_ - The arbitration ID (aka message ID) for the request.*/ + DiagnosticRequestHandle* handle_; /*!< handle_ - A handle for the request to keep track of it between * sending the frames of the request and receiving all frames of the response.*/ - std::string name_; /*!< std::string name_ - An optional human readable name this response, to be used when publishing received + std::string name_; /*!< name_ - An optional human readable name this response, to be used when publishing received * responses. If the name is NULL, the published output will use the raw OBD-II response format.*/ - DiagnosticResponseDecoder decoder_; /*!< decoder - An optional DiagnosticResponseDecoder to parse the payload of responses + DiagnosticResponseDecoder decoder_; /*!< decoder_ - An optional DiagnosticResponseDecoder to parse the payload of responses * to this request. If the decoder is NULL, the output will include the raw payload * instead of a parsed value.*/ - DiagnosticResponseCallback callback_; /*!< callback - An optional DiagnosticResponseCallback to be notified whenever a + DiagnosticResponseCallback callback_; /*!< callback_ - An optional DiagnosticResponseCallback to be notified whenever a * response is received for this request.*/ bool recurring_; /*!< bool recurring_ - If true, this is a recurring request and it will remain as active until explicitly cancelled. * The frequencyClock attribute controls how often a recurrin request is made.*/ - bool waitForMultipleResponses_; /*!< bool waitForMultipleResponses_ - False by default, when any response is received for a request + bool waitForMultipleResponses_; /*!< waitForMultipleResponses_ - False by default, when any response is received for a request * it will be removed from the active list. If true, the request will remain active until the timeout * clock expires, to allow it to receive multiple response (e.g. to a functional broadcast request).*/ - bool inFlight_; /*!< inFlight - True if the request has been sent and we are waiting for a response.*/ - FrequencyClock frequencyClock_; /*!< FrequencyClock frequencyClock_ - A FrequencyClock struct to control the send rate for a + bool inFlight_; /*!< inFlight_ - True if the request has been sent and we are waiting for a response.*/ + FrequencyClock frequency_clock_; /*!< frequency_clock_ - A FrequencyClock object to control the send rate for a * recurring request. If the request is not reecurring, this attribute is not used.*/ - FrequencyClock timeoutClock_; /*!< FrequencyClock timeoutClock_ - A FrequencyClock struct to monitor how long it's been since + FrequencyClock timeout_clock_; /*!< timeout_clock_ - A FrequencyClock object to monitor how long it's been since * this request was sent.*/ public: }; diff --git a/src/diagnostic/diagnostic-message.cpp b/src/diagnostic/diagnostic-message.cpp index d99541b5..76b97996 100644 --- a/src/diagnostic/diagnostic-message.cpp +++ b/src/diagnostic/diagnostic-message.cpp @@ -46,10 +46,10 @@ uint32_t obd2_signal_t::get_pid() * @fn std::vector<std::string> find_signals(const openxc_DynamicField &key) * @brief return signals name found searching through CAN_signals and OBD2 pid * - * @param[in] const openxc_DynamicField : can contain numeric or string value in order to search against + * @param[in] key - can contain numeric or string value in order to search against * can signals or obd2 signals name. * - * @return std::vector<std::string> Vector of signals name found. + * @return Vector of signals name found. */ void obd2_signal_t::find_obd2_signals(const openxc_DynamicField &key, std::vector<obd2_signal_t*>& found_signals) { @@ -148,10 +148,10 @@ bool obd2_signal_t::is_obd2_signal(const char *name) * value of the PID, using the standard formulas (see * http://en.wikipedia.org/wiki/OBD-II_PIDs#Mode_01). * -* @param[in] DiagnosticResponse response - the received DiagnosticResponse (the data is in response.payload, +* @param[in] response - the received DiagnosticResponse (the data is in response.payload, * a byte array). This is most often used when the byte order is * signiticant, i.e. with many OBD-II PID formulas. -* @param[in] float parsed_payload - the entire payload of the response parsed as an int. +* @param[in] parsed_payload - the entire payload of the response parsed as an int. */ float obd2_signal_t::decode_obd2_response(const DiagnosticResponse* response, float parsedPayload) { |