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

Add API reference for components (IEC-57) #248

Open
igrr opened this issue Oct 4, 2023 · 1 comment
Open

Add API reference for components (IEC-57) #248

igrr opened this issue Oct 4, 2023 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@igrr
Copy link
Member

igrr commented Oct 4, 2023

Is your feature request related to a problem?

It is difficult to discover/learn the API of components which aren't ports of well-known libraries.

Describe the solution you'd like.

Component Registry now supports displaying the contents of API.md file, if it is provided in the component directory. We also have a pre-commit hook to generate API.md from Doxygen-generated XML files.

Describe alternatives you've considered.

  • Find the header file of the component, read Doxygen comments
  • Read examples (which are missing from most components...)

Additional context.

Example repo where API.md is set up: https://github.com/igrr/pa1010d

@igrr igrr added the documentation Improvements or additions to documentation label Oct 4, 2023
@github-actions github-actions bot changed the title Add API reference for components Add API reference for components (IEC-57) Oct 4, 2023
@igrr
Copy link
Member Author

igrr commented Oct 4, 2023

At the moment, doxybook only supports a single Doxyfile as input and a single API.md as output. We'll have to change this to make it usable for multiple components in the same repo.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant