Results 1 to 3 of 3

Thread: Problem with RequestFailedException constructor documentation

  1. #1
    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

  2. #2
    marc's Avatar
    marc is offline ZeroC Staff
    Name: Marc Laukien
    Organization: ZeroC, Inc.
    Project: The Internet Communications Engine
    Join Date
    Feb 2003
    Location
    Florida
    Posts
    1,860
    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).

  3. #3
    marc's Avatar
    marc is offline ZeroC Staff
    Name: Marc Laukien
    Organization: ZeroC, Inc.
    Project: The Internet Communications Engine
    Join Date
    Feb 2003
    Location
    Florida
    Posts
    1,860
    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.

Thread Information

Users Browsing this Thread

There are currently 1 users browsing this thread. (0 members and 1 guests)

Similar Threads

  1. Replies: 7
    Last Post: 07-16-2007, 02:17 AM
  2. derived constructor generation bug in slice2cpp
    By bpolivka in forum Bug Reports
    Replies: 3
    Last Post: 03-02-2006, 09:42 AM
  3. Identity Constructor
    By acbell in forum Comments
    Replies: 1
    Last Post: 08-30-2005, 01:34 PM
  4. Passing parameters to constructor
    By jacopo in forum Help Center
    Replies: 2
    Last Post: 05-12-2005, 12:47 PM
  5. Constructor and Default-Parameter
    By Mr.Freeze in forum Help Center
    Replies: 1
    Last Post: 08-13-2003, 07:07 AM

Posting Permissions

  • You may not post new threads
  • You may not post replies
  • You may not post attachments
  • You may not edit your posts
  •