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

A way to add more documentation to Function blocks #217

Closed
n-kristev opened this issue Jun 3, 2016 · 2 comments
Closed

A way to add more documentation to Function blocks #217

n-kristev opened this issue Jun 3, 2016 · 2 comments

Comments

@n-kristev
Copy link

Currently, the only way to document a Function block is through the block's description, and then through properties/operation descriptions. However, this is not always enough - using Java and Javadoc, for example, there is no information about operation parameters or error conditions. It would be good to be able to have more detailed documentation on the Function block and the behaviour of its components.

@Ebolon
Copy link
Contributor

Ebolon commented Nov 27, 2017

Seems like this issue has already been resolved. I can use java comments everywhere.

Function block inherits from Datatype:
grammar org.eclipse.vorto.editor.functionblock.Functionblock with org.eclipse.vorto.editor.datatype.Datatype

Datatype from Terminals:
grammar org.eclipse.vorto.editor.datatype.Datatype with org.eclipse.xtext.common.Terminals

In the terminal rules there are already expressions for java comments included.

@n-kristev
Copy link
Author

Agreed, with the current Function Block DSL syntax all of the use cases I described in the issue are covered. Closing the issue as resolved.

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

No branches or pull requests

3 participants