Results 1 to 5 of 5

Thread: Suggestion on Slice documentation

  1. #1
    n2503v is offline Registered User
    Name: Alex Makarenko
    Organization: ACFR, University of Sydney
    Project: Orca
    Join Date
    Jun 2005
    Posts
    134

    Post Suggestion on Slice documentation

    I find it hard to use chapter B. Slice Documentation as a reference. For each interface the individual methods are spread out over many pages and the method names don't stand out enough so it's hard to scan.

    Personally I'd prefer Qt/Doxygen style where there's a compact list of methods for each class and details come later (hyper links from the list would be ideal). I'd also put all the relavent properties here as well but you probably have a good reason to keep them separated.

    For example:

    Code:
    B.47 Ice::ObjectAdapter
    Methods
    getName
    getCommunicator
    activate
    ...
    Properties
    name.AdapterId
    name.ReplicaGroupId
    ...
    Overview
    local interface ObjectAdapter
    ...
    Used By
    ...
    getName
    string getName();
    ...
    Alex Makarenko
    Marathon Robotics
    project: multi-robot systems

  2. #2
    michi's Avatar
    michi is offline Registered User
    Name: Michi Henning
    Organization: Triodia Technologies
    Project: I have a passing interest in Ice :-)
    Join Date
    Feb 2003
    Location
    Brisbane, Australia
    Posts
    1,055
    We'll have a look whether we can improve this, thanks!

    Cheers,

    Michi.

  3. #3
    ctennis is offline Registered User
    Name: Caleb Tennis
    Organization: AEI
    Project: Project GINA
    Join Date
    Mar 2006
    Posts
    123

    ice_factory documentation

    In 6.14 of the manual, item #5 references the member function "ice_factory". However, no other mention of it is made except for a brief appearance in the section on Freeze.

    I'm curious if you could add it to the documentation and perhaps give me a quick idea of how to use it?

    Thanks.
    Caleb Tennis
    Analytical Engineering, Inc.
    http://www.aei-tech.com
    Project: Our facility infrastructure heavily utilizes Ice

    Gentoo ebuild maintainer for Ice, IceRuby, etc.

  4. #4
    mes's Avatar
    mes
    mes is offline ZeroC Staff
    Name: Mark Spruiell
    Organization: ZeroC, Inc.
    Project: Ice Developer
    Join Date
    Feb 2003
    Location
    California
    Posts
    1,441
    Hi Caleb,

    The ice_factory function is only generated for a concrete Slice class, i.e., a class that does not have (or inherit) operations. The function returns an ObjectFactory object that creates an instance of the generated class. Since Ice does not require an application to manually install factories for concrete class types, there is usually no need to use this function.

    Hope that helps,
    - Mark

  5. #5
    Vewe is offline Registered User
    Join Date
    Aug 2006
    Location
    USA
    Posts
    1
    Great information

Thread Information

Users Browsing this Thread

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

Similar Threads

  1. Some Thoughts and a Suggestion:
    By afcarl in forum Comments
    Replies: 7
    Last Post: 05-06-2010, 12:58 AM
  2. Replies: 1
    Last Post: 03-25-2010, 12:35 PM
  3. Documentation Bug and suggestion for C++ sequences
    By nathanM in forum Bug Reports
    Replies: 4
    Last Post: 10-29-2007, 07:50 PM
  4. Documentation suggestion
    By mwilson in forum Comments
    Replies: 0
    Last Post: 04-12-2006, 04:20 PM
  5. suggestion 1
    By xiehua in forum Comments
    Replies: 0
    Last Post: 11-22-2003, 08:53 PM

Posting Permissions

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