Bug 226773 - [apidoc] Specify allowed namespaces for SimpleSystemMessage ID in the Javadoc
Summary: [apidoc] Specify allowed namespaces for SimpleSystemMessage ID in the Javadoc
Status: RESOLVED FIXED
Alias: None
Product: Target Management
Classification: Tools
Component: RSE (show other bugs)
Version: 3.0   Edit
Hardware: All All
: P2 enhancement (vote)
Target Milestone: 3.0 M7   Edit
Assignee: David McKnight CLA
QA Contact: Martin Oberhuber CLA
URL:
Whiteboard:
Keywords: api
Depends on: 220547
Blocks: 228232
  Show dependency tree
 
Reported: 2008-04-11 18:29 EDT by Martin Oberhuber CLA
Modified: 2008-04-22 12:52 EDT (History)
1 user (show)

See Also:

Attachments
patch with javadoc to describe message id (4.39 KB, patch)
2008-04-15 11:31 EDT, David McKnight CLA 		no flags Details | Diff
View All Add an attachment (proposed patch, testcase, etc.)

Note You need to log in before you can comment on or make changes to this bug.
Description Martin Oberhuber CLA 2008-04-11 18:29:18 EDT 
+++ This bug was initially created as a clone of Bug #220547 +++

As a followup on bug 220547 comment 18, and what we said in the Committer Meetings, I'm still missing the Javadoc that should be saying what "namespaces" of ID's are allowed to use on the SystemMessage ID, for the RSE-Global ID's versus the plugin-specific-local-ID's.

Perhaps it helps looking at the Javadoc of IRSESystemType#testProperty()
which has a similar specification:
http://dsdp.eclipse.org/help/latest/topic/org.eclipse.rse.doc.isv/reference/api/org/eclipse/rse/core/IRSESystemType.html#testProperty(java.lang.String,%20boolean)

Please do this early in M7 such that we get our APIs complete.
Comment 1 Martin Oberhuber CLA 2008-04-11 18:31:16 EDT 
See also bug 220547 comment 14 and followups
Comment 2 David McKnight CLA 2008-04-15 11:31:21 EDT 
Created attachment 96100 [details]
patch with javadoc to describe message id

Here's what I have so far.  Any suggestions on changed wording?
Comment 3 David McKnight CLA 2008-04-21 09:57:28 EDT 
I've committed the patch with the javadoc to cvs.
Comment 4 Martin Oberhuber CLA 2008-04-22 06:50:34 EDT 
I like the doc, except for the sentence "This is part of the work to migrate away from the message file stuff." which I find not specific enough. Either get rid of this sentence, or explain what was meant by "message file stuff".

I'd also like to see some docs where the message id is being used (lookup of error messages in online docs, context help, title of message dialog).
Comment 5 Martin Oberhuber CLA 2008-04-22 06:52:04 EDT 
Just noticed that your new docs introduce incorrect HTML. Instead of
   <subcomponent><number> 
you must write
   &lt;subcomponent&gt;&lt;number&gt;

Also, you <li> markup of the list is missing the <ul></ul> tags on begin and end respectively. Reopening to get the HTML markup fixed.
Comment 6 David McKnight CLA 2008-04-22 09:52:24 EDT 
(In reply to comment #5)
> Just noticed that your new docs introduce incorrect HTML. Instead of
>    <subcomponent><number> 
> you must write
>    &lt;subcomponent&gt;&lt;number&gt;
> Also, you <li> markup of the list is missing the <ul></ul> tags on begin and
> end respectively. Reopening to get the HTML markup fixed.

I've updated the javadoc now and committed that to cvs.
Comment 7 Martin Oberhuber CLA 2008-04-22 11:26:23 EDT 
I also took another stab at improving the docs and comitted my work into SystemMessage.java -- please review and update at your leisure.