docs: improve Doxygen comments, fix typos and alignment across all C++ headers and source files

[Copilot]

Systematic documentation pass over all include/ and src/ C++ files: improve Doxygen coverage, fix English errors, standardise tag style, and replace vague "The method…" phrasing with concise active-voice @brief sentences. No source logic changed.

Typo / grammar fixes

• dmn-debug.hpp: double space in copyright (© 2025 → © 2025)
• dmn-pub-sub.hpp: "adaptar" → "adaptor"; "derivade" → "derived"
• dmn-pipe.hpp: "behevior" → "behavior"
• dmn-io.hpp, dmn-kafka.hpp: "faciliate" → "facilitate"

Missing class / type documentation

• dmn-io.hpp: added @brief + @tparam block to Dmn_Io<T>
• dmn-singleton.hpp: normalised "Design pattern" heading style; "argumented" → "argument-forwarding"
• dmn-blockingqueue-lf.hpp: documented EpochData and Node structs with inline /// member comments; added epoch-parameter constant annotations

Missing constructor / destructor docs

• dmn-timer.hpp, dmn-pipe.hpp, dmn-blockingqueue-lf.hpp: full @brief/@param blocks added

Enum / macro docs

• dmn-proc.hpp: State enum values annotated; DMN_PROC_CLEANUP_PUSH/POP macros given proper @brief
• dmn-kafka.hpp: Role::kConsumer / Role::kProducer annotated

Private / protected method docs

• dmn-dmesgnet.hpp: createInputHandlerProc, createSubscriptHandler, createTimerProc, sendPendingOutboundQueueMessage, getLastTopicCacheInternal — all previously undocumented; macro constants (DMN_DMESGNET_*) given @brief; all private data members converted to inline /// comments
• dmn-blockingqueue-mt.hpp: fixed isInflightGuardClosed doc

Coroutine type docs (dmn-runtime-task.hpp)

• promise_type methods (get_return_object, initial_suspend, return_void, unhandled_exception, final_suspend) and FinalAwaiter / Awaiter methods all documented
• operator co_await overloads and destructor annotated

"The method …" style removed

• dmn-runtime.hpp (10 blocks), dmn-blockingqueue-lf.hpp (3), dmn-blockingqueue-mt.hpp (1), deprecated/dmn-limit-blockingqueue.hpp (7) — all rewritten as active-voice Doxygen

Kafka docs overhaul

• dmn-kafka.hpp: constructor/destructor, read, write, shutdown, producerCallback, errorCallback, writeCopy all improved; grouped /* data members */ sections replaced with inline /// member docs
• dmn-kafka-util.hpp: set_config rewritten with proper @param/@return
• dmn-dmesgnet-kafka.hpp: constructor docs spell out reserved config keys; openHandler/closeHandler simplified; data members inlined

Miscellaneous

• dmn-dmesg.hpp: isInConflict "yes or not" → "@return true/false"; getTopicRunningCounter / setTopicRunningCounter (public and internal) rephrased
• dmn-util.hpp: ScopeGuard and make_scope_guard gain @tparam and @return

Original prompt

Systematically review all C++ source (.cpp) and header (.hpp) files in both the include/ and src/ directories on the main branch of this repo. For each source and header file:

• Improve or add Doxygen-style file, class, struct, enum, function, and variable comments.
• Ensure block comment and tag alignment is neat and consistent.
• Correct any English spelling or grammar mistakes in comments or documentation blocks.
• Provide brief and detailed descriptions where missing.
• Use consistent Doxygen tags (@param, @return, @brief, @details, etc.), and fix any misalignment.
• Remove outdated or duplicate comments.

Leave source logic unchanged except for comment and documentation improvements. This PR is focused solely on documentation and style enhancement, not code refactoring or functional changes.

The following is the prior conversation context from the user's chat exploration (may be truncated):

User: can you assess all source codes in main branch, and create a PR to improve the documentation and doxygen style comment (include alignment, and fix typo)

Assistant: Yes, I can help you create a pull request to improve the documentation and Doxygen-style comments across all source code in the main branch of cheebinhoh/Dmn. I will:

• Assess all source files in the main branch.
• Improve and add Doxygen comments where missing.
• Fix typos and align comments for readability.
• Create a clear and descriptive pull request with these improvements.

Proceeding now to review the codebase and prepare an actionable summary before generating the PR.

Assistant: To address your request for a documentation and Doxygen comment improvement PR:

Assessment Plan

• I have identified all C++ headers in include/ and source files in src/, as well as nested folders like include/deprecated, include/kafka, src/kafka, and src/proto.
• Representative source and header files:
  • Headers:
    • include/dmn-async.hpp, include/dmn-debug.hpp, include/dmn-blockingqueue.hpp, etc.
  • Sources:
    • src/dmn-dmesg-daemon.cpp, src/dmn-dmesg.cpp, src/dmn-kafka-receiver.cpp, etc.
• File count and coverage is sufficient for a full documentation overhaul, including Doxygen re-alignment and typo fixes.

Next Steps
I will now create a pull request in cheebinhoh/Dmn (main branch) to:

• Review each source/header file for Doxygen block presence, alignment, consistency, and quality.
• Improve function/class/module comments and identifier documentation (brief and detailed).
• Fix spelling/grammar issues in all comments.
• Ensure Doxygen formatting, tag alignment, and consistent style throughout.

Confirmation
Proceeding to open a PR that:

• Improves and aligns all Doxygen-style comments,
• Enhances documentation for clarity and completeness,
• Fixes typos throughout relevant source and header files.

If you have specific files, priorities, or naming details for the branch or PR, let me know; otherwise, I'll generate a comprehensive PR.

Assistant: I will create a pull request in cheebinhoh/Dmn to systematically review all C++ source and header files, improve and align Doxygen-style documentation, fix typos, and ensure consistent comment styling—code logic will remain unchanged.

You will receive a PR with these documentation and comment enhancements soon.

This pull request was created from Copilot chat.