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

Semi-automatic generation of documentation for KRL ruleset #624

Open
b1conrad opened this issue Feb 18, 2023 · 1 comment
Open

Semi-automatic generation of documentation for KRL ruleset #624

b1conrad opened this issue Feb 18, 2023 · 1 comment
Labels
documentation enhancement

Comments

@b1conrad
Copy link
Member

An experiment on writing documentation about a KRL ruleset makes me wonder is some of it could be automatically generated from the source code (à la javadoc).

Example:
Screen Shot 2023-02-18 at 07 21 16
@b1conrad
Copy link
Member Author

That being said, I would not be in favor of adding annotations to KRL (in the way Java has done).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation enhancement
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@b1conrad