Iox 4 document public api

[elBoberido]

Pre-Review Checklist for the PR Author

1. Code follows the Rust coding style and is formatted with rustfmt
2. Branch follows the naming format (iox-123-this-is-a-branch)
3. Commits messages are according to this guideline
   • Commit messages have the issue ID (iox-#42 commit text)
   • Commit author matches Eclipse Contributor Agreement (and ECA is signed)
4. Update the PR title
   • Follow the same conventions as for commit messages
   • Link to the relevant issue
5. Relevant issues are linked
6. Add sensible notes for the reviewer
7. All checks have passed (except task-list-completed)
8. Assign PR to reviewer

Notes for Reviewer

This is based on #36 which needs to be merged first.

All the public API should now be documented and the documentation is enforced for writing new public API.

Checklist for the PR Reviewer

• Commits are properly organized and messages are according to the guideline
• Code according to our coding style and naming conventions
• PR title describes the changes

Post-review Checklist for the PR Author

1. All open points are addressed and tracked via issues

References

• Closes Create documentation #4

[codecov-commenter]

Codecov Report

Merging #59 (42c10cd) into master (ff36d1e) will increase coverage by 0.17%.
The diff coverage is 16.66%.

@@            Coverage Diff             @@
##           master      #59      +/-   ##
==========================================
+ Coverage   55.02%   55.20%   +0.17%     
==========================================
  Files          20       20              
  Lines         945      942       -3     
==========================================
  Hits          520      520              
+ Misses        425      422       -3     

Impacted Files	Coverage Δ
iceoryx-sys/src/runtime.rs	100.00% <ø> (ø)
src/error.rs	0.00% <ø> (ø)
src/introspection/memory.rs	0.00% <ø> (ø)
src/introspection/port.rs	0.00% <ø> (ø)
src/introspection/process.rs	0.00% <ø> (ø)
src/lib.rs	100.00% <ø> (ø)
src/publisher.rs	62.75% <0.00%> (ø)
src/sample.rs	59.40% <ø> (ø)
src/sample_mut.rs	70.00% <ø> (ø)
src/subscriber.rs	48.57% <25.00%> (+1.34%)	⬆️

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update ff36d1e...42c10cd. Read the comment docs.