You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@uima.apache.org by "Adam Lally (JIRA)" <ui...@incubator.apache.org> on 2006/12/07 15:50:23 UTC
[jira] Created: (UIMA-104) PackageInstaller and
PackageInstallerException need class javadoc comments
PackageInstaller and PackageInstallerException need class javadoc comments
--------------------------------------------------------------------------
Key: UIMA-104
URL: http://issues.apache.org/jira/browse/UIMA-104
Project: UIMA
Issue Type: Improvement
Components: Core Java Framework
Reporter: Adam Lally
Assigned To: Michael Baessler
Fix For: 2.1
This is particularly important since we expect PackageInstaller to be the most often used class in the pear.tools package, so it needs a comment that makes it stand out to a user who is scanning the javadoc trying to figure out how to install a PEAR file.
I suggest the first sentence be something like "The main user API for installing pear packages." (errr, the first sentence fragment, I guess I should have said :)
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira
Re: [jira] Assigned: (UIMA-104) PackageInstaller and PackageInstallerException need class javadoc comments
Posted by Lev Kozakov <le...@gmail.com>.
On 1/10/07, Michael Baessler (JIRA) <ui...@incubator.apache.org> wrote:
>
>
> [
> https://issues.apache.org/jira/browse/UIMA-104?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel]
>
> Michael Baessler reassigned UIMA-104:
> -------------------------------------
>
> Assignee: Adam Lally (was: Michael Baessler)
>
> I added some JavaDoc comments, please review and close the issue when you
> agree.
I believe, the PackageInstaller.installPackage() method comments need
improvements. I propose the following variant:
"Installs the specified PEAR package to the specified install location.
After the installation is completed, an optional installation verification
step can be executed. This verification uses the main component descriptor
to instantiate the UIMA resource, encapsulated in the PEAR package, and may
run some additional tests, if applicable."
Actually, for AEs the verification creates CAS object, but never calls the
'process' method. For other component categories (CC, CI, CR, CPE, TS) it
just instantiates (produces) the resource. See InstallationTester.java.
> PackageInstaller and PackageInstallerException need class javadoc comments
> >
> --------------------------------------------------------------------------
> >
> > Key: UIMA-104
> > URL: https://issues.apache.org/jira/browse/UIMA-104
> > Project: UIMA
> > Issue Type: Improvement
> > Components: Core Java Framework
> > Reporter: Adam Lally
> > Assigned To: Adam Lally
> > Fix For: 2.1
> >
> >
> > This is particularly important since we expect PackageInstaller to be
> the most often used class in the pear.tools package, so it needs a comment
> that makes it stand out to a user who is scanning the javadoc trying to
> figure out how to install a PEAR file.
> > I suggest the first sentence be something like "The main user API for
> installing pear packages." (errr, the first sentence fragment, I guess I
> should have said :)
>
> --
> This message is automatically generated by JIRA.
> -
> If you think it was sent incorrectly contact one of the administrators:
> https://issues.apache.org/jira/secure/Administrators.jspa
> -
> For more information on JIRA, see: http://www.atlassian.com/software/jira
>
>
>
[jira] Closed: (UIMA-104) PackageInstaller and
PackageInstallerException need class javadoc comments
Posted by "Michael Baessler (JIRA)" <ui...@incubator.apache.org>.
[ https://issues.apache.org/jira/browse/UIMA-104?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Michael Baessler closed UIMA-104.
---------------------------------
Changes are fine with me.
> PackageInstaller and PackageInstallerException need class javadoc comments
> --------------------------------------------------------------------------
>
> Key: UIMA-104
> URL: https://issues.apache.org/jira/browse/UIMA-104
> Project: UIMA
> Issue Type: Improvement
> Components: Core Java Framework
> Reporter: Adam Lally
> Assigned To: Michael Baessler
> Fix For: 2.1
>
>
> This is particularly important since we expect PackageInstaller to be the most often used class in the pear.tools package, so it needs a comment that makes it stand out to a user who is scanning the javadoc trying to figure out how to install a PEAR file.
> I suggest the first sentence be something like "The main user API for installing pear packages." (errr, the first sentence fragment, I guess I should have said :)
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: https://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] Assigned: (UIMA-104) PackageInstaller and
PackageInstallerException need class javadoc comments
Posted by "Michael Baessler (JIRA)" <ui...@incubator.apache.org>.
[ https://issues.apache.org/jira/browse/UIMA-104?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Michael Baessler reassigned UIMA-104:
-------------------------------------
Assignee: Adam Lally (was: Michael Baessler)
I added some JavaDoc comments, please review and close the issue when you agree.
> PackageInstaller and PackageInstallerException need class javadoc comments
> --------------------------------------------------------------------------
>
> Key: UIMA-104
> URL: https://issues.apache.org/jira/browse/UIMA-104
> Project: UIMA
> Issue Type: Improvement
> Components: Core Java Framework
> Reporter: Adam Lally
> Assigned To: Adam Lally
> Fix For: 2.1
>
>
> This is particularly important since we expect PackageInstaller to be the most often used class in the pear.tools package, so it needs a comment that makes it stand out to a user who is scanning the javadoc trying to figure out how to install a PEAR file.
> I suggest the first sentence be something like "The main user API for installing pear packages." (errr, the first sentence fragment, I guess I should have said :)
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: https://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] Resolved: (UIMA-104) PackageInstaller and
PackageInstallerException need class javadoc comments
Posted by "Adam Lally (JIRA)" <ui...@incubator.apache.org>.
[ https://issues.apache.org/jira/browse/UIMA-104?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Adam Lally resolved UIMA-104.
-----------------------------
Resolution: Fixed
Assignee: Michael Baessler (was: Adam Lally)
Applied edits as suggested by Lev. Michael, go ahead and close the issue if you're satisfied.
> PackageInstaller and PackageInstallerException need class javadoc comments
> --------------------------------------------------------------------------
>
> Key: UIMA-104
> URL: https://issues.apache.org/jira/browse/UIMA-104
> Project: UIMA
> Issue Type: Improvement
> Components: Core Java Framework
> Reporter: Adam Lally
> Assigned To: Michael Baessler
> Fix For: 2.1
>
>
> This is particularly important since we expect PackageInstaller to be the most often used class in the pear.tools package, so it needs a comment that makes it stand out to a user who is scanning the javadoc trying to figure out how to install a PEAR file.
> I suggest the first sentence be something like "The main user API for installing pear packages." (errr, the first sentence fragment, I guess I should have said :)
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: https://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira