Go Back   ZeroC Forums > Comments

Reply
 
LinkBack Thread Tools Rate Thread Display Modes
  #1 (permalink)  
Old 02-13-2006
bartley bartley is offline
Registered User
 
Name: Chris Bartley
Organization: Carnegie Mellon University Robotics Institute
Project: The Telepresence Robot Kit (TeRK)
 
Join Date: Dec 2005
Posts: 52
Problem with RequestFailedException constructor documentation

In Ice for Java (and maybe other language mappings as well), the RequestFailedException (and subclasses such as ObjectNotExistException) has two constructors: a no-arg constructor, and a constructor that takes an Identity and two Strings.

The manual describes the three arguments (page 1404), but unfortunately the order in which they're listed is different from the constructor's signature. This makes it a bit unclear which String is which. I'm pretty sure it's identity, facet, operation (judging by the the source code in Connections #11), but the manual should be fixed to list them in the proper order.

I kinda wonder, though, that since this part of the manual was generated from the slice code, whether the slice2docbook program is simply listing the arguments in alphabetical order. If so, this is definitely a bug.

thanks,

chris
Reply With Quote
  #2 (permalink)  
Old 02-13-2006
marc's Avatar
marc marc is offline
ZeroC Staff
 
Name: Marc Laukien
Organization: ZeroC, Inc.
Project: The Internet Communications Engine
 
Join Date: Feb 2003
Location: Florida
Posts: 1,781
This part is indeed generated from the Slice documentation with slice2docbook. However, I don't think there is a bug. From a Slice perspective, there is no such thing as constructors, as these are language-mapping specific constructs. So all the generated documentation lists are the data members of the exception (their names along with their meanings). But I do agree that the constructors should be documented somewhere else (but not in the language-independent Slice reference section).
Reply With Quote
  #3 (permalink)  
Old 02-13-2006
marc's Avatar
marc marc is offline
ZeroC Staff
 
Name: Marc Laukien
Organization: ZeroC, Inc.
Project: The Internet Communications Engine
 
Join Date: Feb 2003
Location: Florida
Posts: 1,781
Actually, I think all we need to do is to list the data members in order, instead of sorting them alphabetically. The order of arguments in constructors can then be derived from the language mapping rules and the Slice reference documentation. I will add this to our TODO list. Thanks for reporting the problem.
Reply With Quote
Reply



Currently Active Users Viewing This Thread: 1 (0 members and 1 guests)
 
Thread Tools
Display Modes Rate This Thread
Rate This Thread:

Posting Rules
You may not post new threads
You may not post replies
You may not post attachments
You may not edit your posts

vB code is On
Smilies are On
[IMG] code is Off
HTML code is Off
Trackbacks are On
Pingbacks are On
Refbacks are On

Similar Threads
Thread Thread Starter Forum Replies Last Post
derived constructor generation bug in slice2cpp bpolivka Bug Reports 3 03-02-2006 10:42 AM
Identity Constructor acbell Comments 1 08-30-2005 02:34 PM
Passing parameters to constructor jacopo Help Center 2 05-12-2005 01:47 PM
Constructor and Default-Parameter Mr.Freeze Help Center 1 08-13-2003 08:07 AM
New Ice documentation available michi Announcements 0 07-10-2003 08:17 AM


All times are GMT -4. The time now is 08:12 PM.


Powered by vBulletin® Version 3.6.4
Copyright ©2000 - 2008, Jelsoft Enterprises Ltd.
Search Engine Optimization by vBSEO 3.0.0
(c) 2008 ZeroC, Inc.