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.

Bug 71202 - Paint and FeedReader Application code needs to be polished
Summary: Paint and FeedReader Application code needs to be polished
Status: RESOLVED FIXED
Alias: None
Product: usersguide
Classification: Unclassified
Component: API Support (show other bugs)
Version: 5.x
Hardware: All All
: P2 blocker (vote)
Assignee: Martin Krauskopf
URL:
Keywords:
Depends on: 71898
Blocks:
  Show dependency tree
 
Reported: 2006-01-09 18:20 UTC by Martin Krauskopf
Modified: 2006-02-07 16:10 UTC (History)
2 users (show)

See Also:
Issue Type: DEFECT
Exception Reporter:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Martin Krauskopf 2006-01-09 18:20:01 UTC
Since it is probably going to be our main tutorial application sample in next
release, its code should be polished and simply and well readable by users. It
is currently in very rough form. IDE-generated headers instead of licences, a
lot of trailing space (also in the midle of the lines), Administrator author,
odd formating tabs vs. spaces (e.g PaintCanvas) and so on. I feel the same
happened to the FeedReader tutorial and now it is late to reclaim it. So just
filing this to prevent to release it in the current state. Also maybe usage of
PMD (or jackpot, or...) would reveal something.

PS: I understand that it was fastly hacked by Tim on his road around the globe ;)
Comment 1 Geertjan Wielenga 2006-02-01 10:48:05 UTC
Not sure what should be done with this issue, if anything. Reassigning to Honza
for evaluation.
Comment 2 Martin Krauskopf 2006-02-01 11:11:02 UTC
> Not sure what should be done with this issue, if anything.

?? It was written above. Not sure what you are not sure about. Code itself is
good. Just needs to be poslished(see above) into representable form. I'll do it.
Comment 3 Geertjan Wielenga 2006-02-01 11:17:10 UTC
Thanks.

Sorry, I didn't know if the changes you suggested had maybe already been done
when Honza fixed up the code some time ago.

So thanks for doing this and, if any of your clean up of the application results
in code changes (doesn't sound like it will), please let me know so that I can
fix the tutorial. (I'm going through and cleaning up the tutorial today.)
Comment 4 Martin Krauskopf 2006-02-01 11:35:55 UTC
Yup, I'm not planning any semantic changes within this issue. I would rather
fill up a new one and CC you there.
Comment 5 Martin Krauskopf 2006-02-06 16:21:21 UTC
BTW does the tutorial needs following direct dependencies (project.xml)? (they
are also noted in the tutorial)

org.openide.dialogs
org.openide.filesystems
org.openide.loaders
org.openide.nodes

It seems it doesn't. So I'll remove them if nobody is against. I'll also sync
deps with those in 5.0.

Also in dev builds we need a depenency on org.netbeans.api.progress since
org.openide.loaders depends on it. Maybe we should also add it into 5.0u1 so the
tutorial created in 5.0 with harness u1 is usable also in dev builds - or better
we shouldn't care about such cases?
Comment 6 Martin Krauskopf 2006-02-06 16:23:50 UTC
> Also in dev builds we need a depenency on org.netbeans.api.progress

More precisely we cannot exclude it from the application (disabled.modules)
Comment 7 Martin Krauskopf 2006-02-07 08:41:23 UTC
I'll also clean-up FeedReader.
Comment 8 Martin Krauskopf 2006-02-07 08:58:57 UTC
- Some cosmetic changes (formatting according to NB defaults, licences, some
  PMDs applied) 
- project.xml: geting rid of unneeded dependencies, use appropriate 5.0 versions

From the Paint App tutorial point of view, probably only section "Specifying the
Module Project's Dependencies" should be adjusted. Since noted dependencies
above are not needed.

samples/PaintApp-sample-ui/src/org/netbeans/modules/apisupport/paintapp/Bundle.properties;
new revision: 1.2; previous revision: 1.1
samples/PaintApp-sample-ui/src/org/netbeans/modules/apisupport/paintapp/PaintAppDescription.html;
new revision: 1.2; previous revision: 1.1
samples/PaintApp-suite/Paint/nbproject/project.xml;
new revision: 1.2; previous revision: 1.1
samples/PaintApp-suite/Paint/src/org/netbeans/paint/Bundle.properties;
new revision: 1.2; previous revision: 1.1
samples/PaintApp-suite/Paint/src/org/netbeans/paint/NewCanvasAction.java;
new revision: 1.2; previous revision: 1.1
samples/PaintApp-suite/Paint/src/org/netbeans/paint/PaintCanvas.java;
new revision: 1.2; previous revision: 1.1
samples/PaintApp-suite/Paint/src/org/netbeans/paint/PaintTopComponent.java;
new revision: 1.2; previous revision: 1.1
samples/PaintApp-suite/Paint/src/org/netbeans/paint/SaveCanvasAction.java;
new revision: 1.2; previous revision: 1.1
samples/PaintApp-suite/nbproject/platform.properties;
new revision: 1.5; previous revision: 1.4
samples/feedreader-sample-ui/src/org/netbeans/modules/apisupport/feedreader/FeedReaderDescription.html;
new revision: 1.3; previous revision: 1.2
samples/feedreader-suite/FeedReader/nbproject/project.xml;
new revision: 1.3; previous revision: 1.2
samples/feedreader-suite/FeedReader/src/org/myorg/feedreader/BrowserTopComponent.java;
new revision: 1.3; previous revision: 1.2
samples/feedreader-suite/FeedReader/src/org/myorg/feedreader/Feed.java;
new revision: 1.4; previous revision: 1.3
samples/feedreader-suite/FeedReader/src/org/myorg/feedreader/FeedAction.java;
new revision: 1.4; previous revision: 1.3
samples/feedreader-suite/FeedReader/src/org/myorg/feedreader/FeedTopComponent.java;
new revision: 1.5; previous revision: 1.4
samples/feedreader-suite/FeedReader/src/org/myorg/feedreader/RssNode.java;
new revision: 1.11; previous revision: 1.10

I will backport into 5.0u1 soon.
Comment 9 Martin Krauskopf 2006-02-07 12:14:14 UTC
Backported.
Comment 10 Jesse Glick 2006-02-07 15:29:37 UTC
BTW it is nice to include a commit log even when backporting, just in case. Less
important than for trunk commits.
Comment 11 Martin Krauskopf 2006-02-07 16:10:45 UTC
Normally I'm doing so, when commits are not exactly the same for both branches.
I'll do next time. Sorry....