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

API Reference generation #11

Open
apjanke opened this issue Sep 15, 2021 · 2 comments
Open

API Reference generation #11

apjanke opened this issue Sep 15, 2021 · 2 comments
Assignees
@apjanke
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Milestone
0.4.0

Comments

@apjanke
Copy link
Member

apjanke commented Sep 15, 2021

Let's add code to automatically generate API Reference documentation (like Javadoc) from source code.
@apjanke apjanke self-assigned this Sep 15, 2021
@apjanke apjanke added documentation Improvements or additions to documentation enhancement New feature or request labels Sep 15, 2021
@apjanke apjanke added this to the 0.4.0 milestone Sep 15, 2021
@apjanke
Copy link
Member Author

apjanke commented Sep 15, 2021

Started work on this here.

Live example can be see here on the project web page. Function doco is barely working; class doco is not working at all.

@apjanke apjanke mentioned this issue Sep 15, 2021
Open
@apjanke
Copy link
Member Author

apjanke commented Sep 15, 2021

Okay, class doco generation is kinda working now; at least the files aren't 404.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@apjanke apjanke

Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Milestone
0.4.0
Development

No branches or pull requests
1 participant
@apjanke