Roland Illig created VFS-518:
--------------------------------
Summary: Documentation of FileSystemOptions should be more helpful
Key: VFS-518
URL: https://issues.apache.org/jira/browse/VFS-518
Project: Commons VFS
Issue Type: Wish
Reporter: Roland Illig
The Javadoc of {{FileSystemOptions}} currently says:
{quote}
Container for FileSystemOptions.
You have to use *FileSystemConfigBuilder.getInstance() to fill this container
{quote}
The first sentence contains no helpful information at all. It should explain
that any file system can be configured and illustrate a typical usage using a
small code example.
I _think_ the documentation should look like this:
{quote}
File systems can be configured individually using these options.
To configure a file system, you set certain properties in a
{{FileSystemOptions}} object. Most filesystems provide a
{{FileSystemConfigBuilder}} that knows the specific options of the file system.
To use the options, they have to be passed to the
{{FileSystemManager.resolveFile()}} method. From there, the options apply to
all files that are resolved relative to that file.
{quote}
These few sentences would have helped me a lot in understanding.
--
This message was sent by Atlassian JIRA
(v6.2#6252)
