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

group examples should be documented #335

Open
luisan00 opened this issue Aug 3, 2022 · 1 comment
Open

group examples should be documented #335

luisan00 opened this issue Aug 3, 2022 · 1 comment
Assignees
Labels
Area: doc Type: enhancement New feature or request
Milestone

Comments

@luisan00
Copy link
Contributor

luisan00 commented Aug 3, 2022

Description

examples/doc.txt should be documented, the file actually contains few lines:

/**
 * @defgroup examples Mesh4all Examples
 * ## This is example-doc
 * All about the Mesh4all examples.
 */

But it should shown us:

  • Description; What is it? or; what it's not
  • Purpose of an example and refs or links (using doxygen syntax ) to current and functional examples
  • Useful information xD

I think boards/doc.txt is a good example of what it should be.

Useful links

https://github.com/Mesh4all/m4a-firmware/blob/main/boards/doc.txt

@luisan00 luisan00 added Type: enhancement New feature or request Area: doc labels Aug 3, 2022
@luisan00 luisan00 added this to the 0.22.12-RC2 milestone Aug 3, 2022
@luisan00
Copy link
Contributor Author

it's ready @eduazocar ?

@luisan00 luisan00 modified the milestones: 0.22.12-RC2, 0.22.12 Oct 11, 2022
@luisan00 luisan00 modified the milestones: 0.22.12, 0.23.06-rc2 Mar 20, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area: doc Type: enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants