This Bugzilla instance is a read-only archive of historic NetBeans bug reports. To report a bug in NetBeans please follow the project's instructions for reporting issues.
I would like to ask for the API Review for the Error Stripe module. Actually, there are five modules: editor/errorstripe - the SPI definition and Error Stripe component implementation editor/errorstripe/annotations - a provider for Error Stripe that shows selected annotations in the Error Stripe java/errorstripe - Error Stripe - Java bridge. tasklist/errorstripe - Error Stripe - Tasklist bridge. latex/errorstripe - Error Stripe - LaTeX bridge The only two modules that provide the API/SPI are editor/errorstripe and editor/errorstripe/annotations. The editor/errorstripe/annotations provides only a tiny SPI through layers. As the arch documents and javadocs will probably change through the process, I will be attaching the up-to-date documentation here: http://editor.netbeans.org/servlets/ProjectDownloadList A patch in nbbuild is required to build the modules. I am attaching the diff to this issue.
I forgot to mention from where you can get the code: the branch name is "errorstripe_spi_2005" (without the quotes). I only branched the following directories: editor/errorstripe java/errorstripe latex/errorstripe not whole modules. It can be checked out like this: cvs -d :pserver:jlahoda@cvs.netbeans.org:/cvs checkout -r errorstripe_spi_2005 -f editor java I mentioned the latex/errorstripe only to be complete, I do not think it should be part of the review.
Directory tasklist/errorstripe has been also branched.
Created attachment 20583 [details] Patch for nbbuild.
The arch descriptions are: for Error Stripe: http://editor.netbeans.org/source/browse/editor/errorstripe/Attic/arch.xml?showattic=1&only_with_tag=errorstripe_spi_2005 for Error Stripe - Annotations: http://editor.netbeans.org/source/browse/editor/errorstripe/annotations/Attic/arch.xml?showattic=1&only_with_tag=errorstripe_spi_2005 I am also attaching HTML architecture description.
Created attachment 20585 [details] Error Stripe Architecture Description.
Created attachment 20586 [details] Error Stripe - Annotations Architecture Description.
Please held the initial review on Apr 27, 2005. The review leader will be Mila and other voting reviewers Martin, Petr and Jano. I hope you succeed - the success, usefulness, usability, maintainability of error stripe lays in your hands!
The errorstripe_spi_2005 branch was merged into the trunk and some more improvements has been done. Currently, the errorstripe modules can be checked out using: cvs checkout -P editor/errorstripe java/errorstripe tasklist/errorstripe I am attaching JavaDoc for the Error Stripe and architecture descriptions for editor/errorstripe and editor/errorstripe/annotations. Please let me know if something is missing.
Created attachment 21705 [details] Error Stripe's javadoc.
Created attachment 21706 [details] Generated architecture description for editor/errorstripe.
Created attachment 21707 [details] Generated architecture description for editor/errorstripe/annotations.
Opinion document was created and it's available at http://openide.netbeans.org/tutorial/reviews/opinions_55639.html
During implementation of the issue #58728, the following problem occurred: I would like to merge the java/errorstripe module into the java (Java Source Files) module. But, the java module should not depend on the errorstripe (because errorstripe depends on the editor, so the java module would in turn depend on the editor). So, I propose to create a new API module for errorstripe, that would contain only the SPI for up-to-date checks. The proposed location of this module is editor/errorstripe/api. All API documentation would be moved into this module. Are there any objections?
From opinions document: > Therefore the error stripe should not display anything that does not have a > corresponding annotation in the editor. CONTRE. I have two use cases where I need to show erros stripe mark only without corresponding annotation in the editor: - CVS diff marks marks places in source that are changed since last update - CVS annotation marks marks all places in annotated (result of special action) source that were introduced by the same commit
FYI current ES annotation implementaion does not scale (issue #59721). I hope it's pure implementation limit unrelated to Annotations API.
*** Issue 21227 has been marked as a duplicate of this issue. ***
The requested changes are done on the errorstripe_55639 branch. Branched is: -whole editor module -java/src and java/nbproject -openide/text/src/org/openide/text/doc-files/api.html -nbbuild/build.xml, build.properties, cluster.properties Changes: -only two modules will remain: editor/errorstripe/api and editor/errorstripe. Other modules (editor/errorstripe/annotations, editor/errorstripe/feature, java/errorstripe and tasklist/errorstripe) will be removed (java/errorstripe and tasklist/errorstripe are not branched and will be removed during merge). -the annotation XML description was enhanced by a few attributes, see http://openide.netbeans.org/source/browse/openide/text/src/org/openide/text/doc-files/api.html?r1=1.1&r2=1.1.4.2 for details -Mark interface removed from the SPI (moved into a non-public package), only UpToDateStatusProvider remains -java/errorstripe's functionality has been merged into java source files module. -editor/errorstripe/annotations' functionality merged into editor/errorstripe. I will attach arch document and javadoc for the errorstripe/api module.
Created attachment 22809 [details] Arch document for the errorstripe/api module.
Created attachment 22810 [details] Javadoc for errorstripe/api.
The Error Stripe's API review is done.