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.

Sign up for GitHub

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

Jump to bottom

Feature/api documentation improvement #100

Merged
merged 66 commits into from
Dec 1, 2020
Merged

Feature/api documentation improvement #100

merged 66 commits into from
Dec 1, 2020

Conversation

rfeistenauer
Copy link
Contributor

@rfeistenauer rfeistenauer commented Nov 12, 2020 •
edited
Loading

Description

These changes improve the API documentation by clarifying the responsibilities of classes and the class structure.

Things to add, update or check before this PR can be merged.

Review Checklist

  • Soft- and hardware architecture (diagrams and description)
  • Test review (test plan and individual test cases)
  • Documentation review
  • Code (coding rules, style guide)

Release planning (please answer)

  • When is the new feature released?
    Needs an release to update the online documentation but is not urgent?

  • Which dependent packages do have to be released simultaneously?
    None

@rfeistenauer rfeistenauer changed the base branch from feature/get_state_name to melodic-devel November 12, 2020 14:18
@cdoehn cdoehn changed the base branch from melodic-devel to main November 13, 2020 16:28
@rfeistenauer rfeistenauer force-pushed the feature/api_documentation_improvement branch from 20c5a57 to 82df44b Compare November 19, 2020 13:21
cdoehn
cdoehn requested changes Nov 24, 2020
View reviewed changes
Copy link
Collaborator

@cdoehn cdoehn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Additionaly, I think the toLaserScan function should be documented, because it owns an important functionality

include/psen_scan_v2/monitoring_frame_deserialization.h Outdated Show resolved Hide resolved
include/psen_scan_v2/monitoring_frame_deserialization.h Outdated Show resolved Hide resolved
include/psen_scan_v2/monitoring_frame_deserialization.h Outdated Show resolved Hide resolved
include/psen_scan_v2/monitoring_frame_deserialization.h Outdated Show resolved Hide resolved
include/psen_scan_v2/ros_scanner_node.h Outdated Show resolved Hide resolved
include/psen_scan_v2/scanner_interface.h Outdated Show resolved Hide resolved
rfeistenauer and others added 26 commits November 26, 2020 08:22
@rfeistenauer
Improves the laserscan class documentation
b689dac
@rfeistenauer
Adds doc/Readme.md as main page
fe11475
@rfeistenauer
Adds More class api documentation
bb72f31
@rfeistenauer
Adds documentation to watchdog related classes
0cf5822
@rfeistenauer
Adds some monitoring frame related documentation
d6c5ab5
@rfeistenauer
Improves watchdog doc
c668ca9
@rfeistenauer
clang-format 3.9 conformity
2e8ae4f
@rfeistenauer
Add doc-html folder to excludes in .gitignore
9a4e083
@rfeistenauer
Remove redundant scope operator
06535d6
@rfeistenauer
Fix unsupported html tag warning
bf69844
@rfeistenauer
Fix second unsupported html warning
614cea4
@rfeistenauer
Add documentation for StringStreamFailure class
64194c6
@rfeistenauer
Add documentation for transition_table struct
16ae3b7
@rfeistenauer
Add documentation to raw_processing namespace
9e9bd41
@rfeistenauer
Add documentation to format_error namespace
fd72c71
@rfeistenauer
Add documentation to scanner_protocol namespace
c24434d
@rfeistenauer
Add documentation for the scanner_events namespace
4a5c54e
@rfeistenauer
Add documentation to the StateMachineArgs class
26a8c04
@rfeistenauer
Add documentation for the additonal_field namespace
bc76e9e
@rfeistenauer
Add documentation for the psen_scan_v2 namespace
e89a07f
@rfeistenauer
Add missing word in psen_scan_v2 namespace docu
b543cf4
@rfeistenauer
Add docu for CRCMismatch class
0dfc1e0
@rfeistenauer
Add documentation for scanner_reply namespace
732498f
@rfeistenauer
Add documetnation for the diagnostic namespace
0513de4
@rfeistenauer
Add documentation for start_request namespace
a03ac22
@rfeistenauer
Add documentation for the LaserScanSettings class
ee20459
rfeistenauer and others added 10 commits November 26, 2020 08:22
@rfeistenauer
Moved some elements in the sequence diagram
0ce7e83
@rfeistenauer
Adds changelog entry
e6c5911
@rfeistenauer @cdoehn
Fixes Header docu
e3f9b67 
Co-authored-by: cdoehn <55837480+cdoehn@users.noreply.github.com>
@rfeistenauer @cdoehn
Fixed monitoring_frame docu
b9c6a70 
Co-authored-by: cdoehn <55837480+cdoehn@users.noreply.github.com>
@rfeistenauer @cdoehn
Fixes additional_field docu
596bc16 
Co-authored-by: cdoehn <55837480+cdoehn@users.noreply.github.com>
@rfeistenauer @cdoehn
Fixes monitoring_frame docu
c098032 
Co-authored-by: cdoehn <55837480+cdoehn@users.noreply.github.com>
@rfeistenauer @cdoehn
Fixes ROSScannerNodeT docu
464591f 
Co-authored-by: cdoehn <55837480+cdoehn@users.noreply.github.com>
@rfeistenauer @cdoehn
Fixes IScanner docu
0a3155a 
Co-authored-by: cdoehn <55837480+cdoehn@users.noreply.github.com>
@rfeistenauer
Adds toLaserScan docu
ada5db4
@rfeistenauer
Fixes Clang Format of Docu
f3ff5ba
@rfeistenauer rfeistenauer force-pushed the feature/api_documentation_improvement branch from 45ab5b7 to f3ff5ba Compare November 26, 2020 07:24
@rfeistenauer rfeistenauer marked this pull request as ready for review November 26, 2020 07:24
@rfeistenauer rfeistenauer requested a review from cdoehn November 26, 2020 07:31
ct2034
ct2034 suggested changes Nov 26, 2020
View reviewed changes
doc/api_sequence_diag.uxf Show resolved Hide resolved
doc/api_sequence_diag.uxf Show resolved Hide resolved
doc/README.md Show resolved Hide resolved
doc/calls_and_callbacks.md Show resolved Hide resolved
doc/diag_comp_overall_architecture.uxf Outdated Show resolved Hide resolved
include/psen_scan_v2/laserscan_conversions.h Outdated Show resolved Hide resolved
include/psen_scan_v2/monitoring_frame_deserialization.h Show resolved Hide resolved
include/psen_scan_v2/monitoring_frame_deserialization.h Outdated Show resolved Hide resolved
include/psen_scan_v2/monitoring_frame_deserialization.h Outdated Show resolved Hide resolved
include/psen_scan_v2/monitoring_frame_deserialization.h Outdated Show resolved Hide resolved
@rfeistenauer rfeistenauer requested a review from ct2034 December 1, 2020 07:37
@rfeistenauer rfeistenauer merged commit e1219e5 into main Dec 1, 2020
@rfeistenauer rfeistenauer deleted the feature/api_documentation_improvement branch December 1, 2020 08:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jschleicher jschleicher jschleicher left review comments

@cdoehn cdoehn Awaiting requested review from cdoehn

@ct2034 ct2034 Awaiting requested review from ct2034

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@rfeistenauer @ct2034 @jschleicher @cdoehn