search

vaadin / framework

Vaadin 6, 7, 8 is a Java framework for modern Java web applications.
http://vaadin.com/
Other
1.79k stars 729 forks source link

Small error in CustomLayout javadoc #7508

Closed vaadin-bot closed 4 years ago

vaadin-bot commented 8 years ago

Originally by jnash67@yahoo.com

Constructor: public CustomLayout(String template) has comments:

/**
 - Constructor for custom layout with given template name. Template file is
 - fetched from "<theme>/layout/<templateName>".
 -/

The directory in the theme folder is "layouts" not "layout"

Imported from https://dev.vaadin.com/ issue #19598

vaadin-bot commented 8 years ago

Originally by @magi42

Reassigning to the framework team.

The constructor's documentation is also otherwise rather unclear. It's not completely obvious that "/layout/" refers to a path and a filename. What is it relative to? It doesn't mention that the template is a HTML file with .html suffix.

Whoever looks into this could also check that other parts of the CustomLayout API doc make sense.

stale[bot] commented 6 years ago

A lot of tickets have been left hanging in the issue tracker through the years. Some of them are still relevant, some of them have been fixed a long time ago and some are no longer valid. To get a better look on what is important and still relevant, we are closing old tickets which have not been touched in a long time. No further work will be done on this ticket. If the ticket seems to be still actual, please verify the problem existence over latest framework version and then open a new ticket in vaadin/framework with all the suitable information.

stale[bot] commented 4 years ago

The issue was automatically closed due to inactivity. If you found some new details to it or started working on it, comment on the issue so that maintainers can re-open it.

TatuLund commented 4 years ago

The JavaDoc seems to be corrected in Vaadin 8.11.