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

Improve documentation #4

Open
mid-kid opened this issue Jan 2, 2020 · 2 comments
Open

Improve documentation #4

mid-kid opened this issue Jan 2, 2020 · 2 comments

Comments

@mid-kid
Copy link
Member

mid-kid commented Jan 2, 2020

libmobile should be documented, focussing on easy implementation by emulators. This includes implementation requirements/expectations and tips, such as that single-thread usage is fine, but multithread is preferable, and how to synchronize the timeouts (when REONTeam/ArduinoAdapterGB#2 is implemented).

@mid-kid mid-kid changed the title Improve documentation libmobile: Improve documentation Jan 2, 2020
@mid-kid mid-kid transferred this issue from REONTeam/ArduinoAdapterGB Aug 20, 2021
@mid-kid mid-kid changed the title libmobile: Improve documentation Improve documentation Aug 20, 2021
@mid-kid
Copy link
Member Author

mid-kid commented Aug 30, 2021

This was lightly touched upon for the v0.1 release, documenting the mobile_board_* commands, as those are by far the most implementation-sensitive. The rest is yet to be documented.

@mid-kid
Copy link
Member Author

mid-kid commented Dec 27, 2022

I've used doxygen for a different project, making me positive of using it as a documentation generator. Comments should be converted and a good general overview should be written up.

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

No branches or pull requests

1 participant