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 source code documentation #8

Open
clange opened this issue Apr 27, 2016 · 0 comments
Open

Add source code documentation #8

clange opened this issue Apr 27, 2016 · 0 comments
Assignees

Comments

@clange
Copy link

clange commented Apr 27, 2016

… in the documentation syntax of the respective programming language. E.g. the Pipeline currently has some simple Java comments (which, inside long methods, is actually a good thing!), but it does not have Javadoc documentation. There should be Javadoc documentation of at least one sentence per class, public or protected method, and parameter of each public or protected method. Analogously for other programming languages.

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

2 participants