You are viewing a plain text version of this content. The canonical link for it is here.
Posted to java-dev@axis.apache.org by "Daniel B. (Commented) (JIRA)" <ji...@apache.org> on 2012/03/05 16:57:58 UTC
[jira] [Commented] (AXIS2-5259) incoherent method description for
ConfigurationContextFactory.createConfigurationContextFromFileSystem
[ https://issues.apache.org/jira/browse/AXIS2-5259?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13222418#comment-13222418 ]
Daniel B. commented on AXIS2-5259:
----------------------------------
I wrote:
> Especially given that there is no class description (to say what a ConfigurationContextFactory is in
> the first place), that method is just about impossible to know how to use from that documentation.
Oops. Never mind that part. (I mixed up the no-class-description ConfigurationContextFactory (which
doesn't as critically need a class description) with ConfigurationContext (which does have a class
description).
> incoherent method description for ConfigurationContextFactory.createConfigurationContextFromFileSystem
> ------------------------------------------------------------------------------------------------------
>
> Key: AXIS2-5259
> URL: https://issues.apache.org/jira/browse/AXIS2-5259
> Project: Axis2
> Issue Type: Bug
> Components: documentation
> Affects Versions: 1.4.1, 1.6.1
> Environment: any
> Reporter: Daniel B.
>
> The method description for method createConfigurationContextFromFileSystem(String, String) of
> class org.apache.axis2.context.ConfigurationContextFactory begins:
> To get a ConfigurationContext for given data , and underline implementation is Axis2 default
> impl which is file system based deployment model to create an AxisConfiguration.
> Huh? That is, that text is so screwed up it's hard to give any specific suggestions.
> The description continues:
> Here either or both parameter can be null. So that boil down to following scenarios and it should
> note that parameter value should be full path , you are not allowed to give one relative to other.
> And these two can be located in completely different locations.
> All those editorial errors should be fixed, possibly by replacing that paragraph with:
> Here either or both parameters can be null. So that boils down to the following scenarios and it should
> be noted that the parameter values should be full pathnames; you are not allowed to give one relative to
> the other. And these two can refer to completely different locations.
> Actually, the rest of the method description needs major editing (and probably a complete rewrite).
> Especially given that there is no class description (to say what a ConfigurationContextFactory is in
> the first place), that method is just about impossible to know how to use from that documentation.
> This applies to the version 1.6.1 (at
> http://axis.apache.org/axis2/java/core/api/org/apache/axis2/context/ConfigurationContextFactory.html#createConfigurationContextFromFileSystem%28java.lang.String,%20java.lang.String%29) and version 1.4.1 9 (and presumably every version in between).
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
---------------------------------------------------------------------
To unsubscribe, e-mail: java-dev-unsubscribe@axis.apache.org
For additional commands, e-mail: java-dev-help@axis.apache.org