You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit 0118c8f
Browse filesBrowse the repository at this point in the historyBrowse files
docs: document the members of the files this change touches that Doxygen flags
The Docs check fails a pull request on any Doxygen warning in a file it changes,
old ones included (#132). This change touches e3_agent.hpp, e3_connector.hpp,
subscription_manager.hpp, c_api.h and posix_connector.hpp, so their gaps are
filled here instead of being left for the check to report.
* @return and @PARAM for the accessors, setters and callbacks of E3Agent,
E3Connector and SubscriptionManager; a one-line description for the handler
type aliases, the move operations and the data members.
* e3_config_t and e3_c_service_model_desc_t get a `///<` description for every
member, in place of the `//` and `/* */` comments, which Doxygen does not read.
The struct and the SM handle in c_api.cpp, E3Agent::Impl and
DAppSession::Impl are described, as is each of their members.
* A log path pattern written `<role>` is written without the angle brackets,
which Doxygen read as an HTML tag.
The integrator guide's line pointers follow the added comment lines. Comments
only: no code changes.
Assisted-by: Claude:claude-sonnet-5-5
Signed-off-by: Thecave3 <thecave003@gmail.com>
Copy file name to clipboardExpand all lines: docs/e3ap/integrator-guide.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -84,7 +84,7 @@ in the connectors.
84
84
| The dApp handles every MESSAGE ACK, with no dApp filter |`e3_interface.cpp:1812-1826`|
85
85
| dApp report goes through a queue of 1024 and a worker |`e3_interface.cpp:687-717`, `800-821`, `1297-1305`|
86
86
| A report with `sequence_id` 0 is refused with `INVALID_PARAM`|`e3_interface.cpp:1957`|
87
-
| xApp control from the E3 Agent has no check of `sequence_id`|`src/core/e3_agent.cpp:230-251`|
87
+
| xApp control from the E3 Agent has no check of `sequence_id`|`src/core/e3_agent.cpp:234-255`|
88
88
| Release from the dApp: unregister, free identifiers, stop service models |`e3_interface.cpp:1307-1330`; `subscription_manager.cpp:84-138`|
89
89
| RELEASE from the E3 Agent to a dApp that sent nothing for `dapp_idle_timeout_s` (default 1800 s, 0 is off): queued first, then the removal a release from the dApp gets. Only what the dApp sends resets the time |`e3_interface.cpp:1428-1448`; `subscription_manager.cpp:403-410`, `422-434`|
90
90
| RELEASE from the E3 Agent: the dApp clears its session |`e3_interface.cpp:1665-1698`|
| Framed receive refuses 0 and more than 65536 |`posix_connector.cpp:999`|
102
102
| The dApp sends unframed |`posix_connector.cpp:681`, `798`|
103
103
| The E3 Agent reads one raw `recv()` of up to 60000 octets |`posix_connector.cpp:355`, `537`|
@@ -129,7 +129,7 @@ Update the hex in `tests/test_asn1_golden.cpp` and add a row to the change ledge
129
129
These comments disagree with the code. They are not discrepancies of the protocol.
130
130
131
131
*`include/libe3/types.hpp:538` says dApp identifiers are 1 to 100. The range is 1 to 65535.
132
-
*`include/libe3/subscription_manager.hpp:114` says at most 101 dApps. `:148` says RAN function identifiers 0 to 255. `:34` and `:151` say that periodicity 0 means "the service model default".
132
+
*`include/libe3/subscription_manager.hpp:115` says at most 101 dApps. `:148` says RAN function identifiers 0 to 255. `:34` and `:151` say that periodicity 0 means "the service model default".
133
133
*`types.hpp:211` and `e3_encoder.hpp:81` use `0.0.0` as the version example. The default is `1.0.0`.
134
134
*`types.hpp:442` and `include/libe3/c_api.h:166` leave Protobuf out of the encoding comments.
135
135
*`include/libe3/e3_agent.hpp` says `register_sm` returns `STATE_ERROR` when the agent runs. It does not.
0 commit comments