Next in thread → Next in month →

RE: [wsrp-wsia] [I#173] Add summary of interfaces in beginning ofinterface chapters

From
Eilon Reshef <>
Date
2002-12-11T21:48:55+00:00
ID
00af01c2a160$061cd380$1686ef18@eilon
Thread
RE: [wsrp-wsia] [I#173] Add summary of interfaces in beginning ofinterface chapters
Title: Message

My preference though would be to have such a chapter in the beginning. 
Although it's very hard to read a javadoc if you don't understand the model 
behind a class, it is nevertheless (once you get the gist of the matters) where 
one typically "starts" looking for info - so such a summary (IMHO) should be in 
the beginning, not an appendix.

  

  
-----Original Message-----
From: Gil Tayar 
  [mailto:] 
Sent: Tuesday, December 10, 2002 
  11:36 PM
To: 
Subject: RE: 
  [wsrp-wsia] [I#173] Add summary of interfaces in beginning of interface 
  chapters

  
I believe that would be even better. 

  
-----Original Message----- 
From: Rich 
  Thompson [mailto:] 
Sent: Tue, December 10, 2002 21:13 
To: 
   
Subject: Re: 
  [wsrp-wsia] [I#173] Add summary of interfaces in beginning 
of interface chapters 

  
This seems like it would not have enough context to be helpful 
  ... perhaps 
a chapter that reiterated the signatures, 
  much as we have a chapter that 
enumerates all the data 
  structures. 

  
Rich Thompson 

  
 

  
                      
  Gil Tayar 

  
                      
  <Gil.Tayar@webcol        To: 
  
                                  
  
                      
  lage.com>                
  cc: 

  
                                               
  Subject:  [wsrp-wsia] [I#173] 
Add summary of 
  interfaces in beginning of   
                      
  12/10/2002 03:18          
  interface chapt      ers 

  
                      
  AM 

  
 

  
 

  
Issue: 173 
Status: Active 
  
Topic: interface 
Class: 
  Editorial 
Raised by: Eilon Reshef 
Title: Add summary of interfaces in beginning of interface 
  chapters 
Date Added: 10-Dec-2002 
Document Section:   v0.85/4.*, 5., 6.*, 7.* 
Description: 
Can we add a summary of the 
  signatures of the operaion at the beginning of 
each of 
  the sections (maybe javadoc-like?) 

  
---------------------------------------------------------------- 
  
To subscribe or unsubscribe from this elist use the 
  subscription 
manager: <http://lists.oasis-open.org/ob/adm.pl> 
  

  
---------------------------------------------------------------- 
  
To subscribe or unsubscribe from this elist use the 
  subscription 
manager: <http://lists.oasis-open.org/ob/adm.pl>
Next in thread → Next in month →