Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refactored libocpp documentation #847

Merged
merged 9 commits into from
Nov 15, 2024
Merged

Refactored libocpp documentation #847

merged 9 commits into from
Nov 15, 2024

Conversation

Pietfried
Copy link
Contributor

@Pietfried Pietfried commented Oct 25, 2024

Describe your changes

This PR:

  • reduced the README to essential and high-level information
  • created a dedicated section for developer documentation for v16, v201 and common.

This PR does not change or remove any existing content except for style and improvements.

It shall build the foundation to apply changes suggested in #836

Issue ticket number and link

Checklist before requesting a review

@maaikez
Copy link
Contributor

maaikez commented Nov 1, 2024

I created a patch for the doxygen changes with the topic. I don't know if I should open a separate pull request for it or if you want to include it here. So here is the patch, let me know if you want me to add this to this branch or something.

doxygen-Changes-On-4c1f3e.patch.txt

@Pietfried Pietfried force-pushed the docs/refactor-readme branch from db80fa3 to a621ec3 Compare November 11, 2024 16:11
@Pietfried Pietfried assigned maaikez and Pietfried and unassigned hikinggrass Nov 11, 2024
@Pietfried Pietfried marked this pull request as ready for review November 11, 2024 18:33
@Pietfried Pietfried force-pushed the docs/refactor-readme branch from 7fa441b to 477a36c Compare November 11, 2024 18:34
doc/v16/getting_started.md Outdated Show resolved Hide resolved
doc/v16/getting_started.md Outdated Show resolved Hide resolved
Pietfried and others added 8 commits November 14, 2024 11:57
* reduced the README to essential and high-level information about libocpp
* created a dedicated section for developer documentation

Signed-off-by: Piet Gömpel <[email protected]>
Signed-off-by: Maaike Zijderveld, iolar <[email protected]>
Signed-off-by: Piet Gömpel <[email protected]>
Signed-off-by: Maaike Zijderveld, iolar <[email protected]>
Signed-off-by: Piet Gömpel <[email protected]>
Signed-off-by: Maaike Zijderveld, iolar <[email protected]>
Signed-off-by: Piet Gömpel <[email protected]>
* Enable coverage generation
* Use reusable workflow
* Remove old install_and_test script
* Set specific paths for ctest and coverage results
* Exclude tests directory from code coverage

---------

Signed-off-by: Kai-Uwe Hermann <[email protected]>
Signed-off-by: Piet Gömpel <[email protected]>
…this->status->get_state(connector) == ChargePointStatus::Faulted since the internal state of the state machine could be other then Faulted, which would lead to an unspecified transaction not moving back to Available (#865)

Signed-off-by: Piet Gömpel <[email protected]>
* Fixed an issue when setting the NetworkConfigurationPriority. During the validation, every entry of the new priority list was checked using the connectivity_managers cached slots. The slots of the connectivity manager are only initialized at startup. A new profile could have been send using a SetNetworkProfile.req by the CSMS at runtime, so when validating the NetworkConfigurationPriority we shall not use the cached connectivity_manager slots but the NetworkConnectionProfiles stored in the device model

---------

Signed-off-by: Piet Gömpel <[email protected]>
Signed-off-by: Piet Gömpel <[email protected]>
@Pietfried Pietfried force-pushed the docs/refactor-readme branch from 6fc605b to 731417b Compare November 14, 2024 10:57
@Pietfried Pietfried merged commit 74f82e3 into main Nov 15, 2024
7 of 8 checks passed
@Pietfried Pietfried deleted the docs/refactor-readme branch November 15, 2024 12:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants