Api documentation

[wsobel]

• Added API documentation to most of the classes in the agent lib.
• Still need to document MQTT and Ruby classes
• Primarily to support plugins that provide sinks, sources, and transforms.

[wsobel]

Please correct in a branch. Tracking down a few problems around the mqtt isolation test failing on windows.

On Feb 10, 2023, at 16:15, rajwork9 @.***> wrote:

@rajwork9 commented on this pull request.

Hello Will,

found very minor spell checks... you can skip these changes as well.

Thank you,

In src/mtconnect/asset/asset_storage.hpp https://github.com/mtconnect/cppagent_dev/pull/249#discussion_r1103051197:

   virtual AssetPtr getAsset(const std::string &id) const = 0;

• /// @brief get a list of assets with optional filters
• /// @param[out] list returned list of assets
• /// @param[in] max maximum number of assets to dind it's find? may be typo issue...at line 104

In src/mtconnect/buffer/circular_buffer.hpp https://github.com/mtconnect/cppagent_dev/pull/249#discussion_r1103341309:

@@ -55,14 +62,24 @@ namespace mtconnect::buffer { return observation::ObservationPtr(); }

• auto getIndexAt(uint64_t at) { return at - m_firstSequence; }
• /// @brief get index into underlying curcular buffer at a sequence number spell check: circular buffer

In src/mtconnect/buffer/circular_buffer.hpp https://github.com/mtconnect/cppagent_dev/pull/249#discussion_r1103346611:

@@ -184,11 +223,21 @@ namespace mtconnect::buffer {

   return check;
 }

-

• ///@}
• /// @brief Get a list of observations from the curcular buffer spell check: Circular

In src/mtconnect/configuration/agent_config.hpp https://github.com/mtconnect/cppagent_dev/pull/249#discussion_r1103351572:

   auto &getAsyncContext() { return *m_context.get(); }

• /// @brief sets the path for the working directory to the crrent path spell check: current

In src/mtconnect/configuration/agent_config.hpp https://github.com/mtconnect/cppagent_dev/pull/249#discussion_r1103353483:

   const auto &getLogArchivePattern() const { return m_logArchivePattern; }

• /// @brief Get the maximum size of all the log files
• /// @return the maxumum size of all log files spell check: maximum

In src/mtconnect/device_model/component.hpp https://github.com/mtconnect/cppagent_dev/pull/249#discussion_r1103368797:

   void setUuid(const std::string &uuid)

{ m_uuid = uuid; setProperty("uuid", uuid); }

• /// @brief set the compoent name property, not the compoent type spell check: component

In src/mtconnect/device_model/device.hpp https://github.com/mtconnect/cppagent_dev/pull/249#discussion_r1103375467:

namespace device_model {

• /// @brief Compenent entity representing a Device spell check: component

In src/mtconnect/observation/change_observer.hpp https://github.com/mtconnect/cppagent_dev/pull/249#discussion_r1103406542:

@@ -27,85 +27,107 @@

include "mtconnect/config.hpp"

include "mtconnect/utilities.hpp"

-namespace mtconnect {

• namespace observation {
• class ChangeSignaler;
• class AGENT_LIB_API ChangeObserver +namespace mtconnect::observation {
• class ChangeSignaler;
• /// @brief A class to observe a data item and singal when data changes spell check: signal

In src/mtconnect/pipeline/period_filter.hpp https://github.com/mtconnect/cppagent_dev/pull/249#discussion_r1103418020:

• // The observations will be swapped, so send the last onward.
• return false;
• }
• else
• // The observations will be swapped, so send the last onward.
• return false;
• }
• else
• {
• // If this observation is after the period has expired and there
• // is an existing obsrvation, then we send the last observation. spell check: Observation

— Reply to this email directly, view it on GitHub https://github.com/mtconnect/cppagent_dev/pull/249#pullrequestreview-1293705608, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAJ6BCIOVXRRZFDKBHYRY4DWW3KZ3ANCNFSM6AAAAAAUW73DBM. You are receiving this because you modified the open/close state.

[wsobel]

Will fix it in the current branch I'm working on for the config and mqtt test issues

[wsobel]

fixed in branch fix_debug_build_in_windows.

Thanks a lot for finding the errors!