[Oorexx-bugs] [ oorexx-Bugs-1623767 ] "String" and "Uninit" methods missing from "Stream" docs

[SourceForge.net <no...@so...>]

Bugs item #1623767, was opened at 2006-12-28 18:05
Message generated for change (Comment added) made by orexx
You can respond by visiting: 
https://sourceforge.net/tracker/?func=detail&atid=684730&aid=1623767&group_id=119701

Please note that this message will contain a full copy of the comment thread,
including the initial issue submission, for this request,
not just the latest update.
Category: Documentation
Group: v3.1
>Status: Open
Resolution: Rejected
Priority: 5
Private: No
Submitted By: Rony G. Flatscher (orexx)
Assigned to: David Ashley (wdashley)
Summary: "String" and "Uninit" methods missing from "Stream" docs

Initial Comment:
The Stream class according to its methods collection possesses the following methods that are not documented yet: 

- STRING (returns the name of the stream, i.e., the argument to the NEW/INIT method)

- UNINIT (*speculation*: probably to clean up the stream's system resources)

---rony


----------------------------------------------------------------------

>Comment By: Rony G. Flatscher (orexx)
Date: 2007-01-19 17:27

Message:
Logged In: YES 
user_id=662126
Originator: YES

David, 

as Rick mentioned "UNINIT" is not inherited by Object, and "STRING" is
overriden by the stream class (like "INIT" which gets listed).

Here's a "quickie" to list all methods of the .stream class in ooRexx
3.1.1 using rexxtry.rex:

E:\rony\dev\bsf\src>rexxtry
REXX-ooRexx_3.1(MT) 6.00 7 Dec 2006
  rexxtry.rex lets you interactively try REXX statements.
    Each string is executed when you hit Enter.
    Enter 'call tell' for a description of the features.
  Go on - try a few...            Enter 'exit' to end.
s=.stream~methods(.stream);do while s~available;say s~index~right(20)":"
s~item; s~next;end
              LINEIN: a Method
      !C_STREAM_INIT: a Method
                SEEK: a Method
               LINES: a Method
     !QUERY_POSITION: a Method
                INIT: a Method
               CLOSE: a Method
       !QUERY_EXISTS: a Method
             ARRAYIN: a Method
              CHARIN: a Method
            POSITION: a Method
         !QUERY_SIZE: a Method
               STATE: a Method
              UNINIT: a Method
         DESCRIPTION: a Method
                 SAY: a Method
             LINEOUT: a Method
             CHAROUT: a Method
         !HANDLE_SET: a Method
   !QUERY_STREAMTYPE: a Method
              STRING: a Method
            !STD_SET: a Method
       !QUERY_HANDLE: a Method
               FLUSH: a Method
         !QUERY_TIME: a Method
               CHARS: a Method
             QUALIFY: a Method
            ARRAYOUT: a Method
           MAKEARRAY: a Method
            SUPPLIER: a Method
             COMMAND: a Method
                OPEN: a Method
               QUERY: a Method
  ........................................... rexxtry.rex on WindowsNT

Regards,

---rony



----------------------------------------------------------------------

Comment By: Rick McGuire (bigrixx)
Date: 2007-01-19 17:08

Message:
Logged In: YES 
user_id=1125291
Originator: NO

If a class has its own implementation of a method (i.e., overrides the
default), then it should be documented.  This is particularly important for
UNINIT(), which is NOT inherited from object.  

----------------------------------------------------------------------

Comment By: David Ashley (wdashley)
Date: 2007-01-19 16:58

Message:
Logged In: YES 
user_id=931756
Originator: NO

These methods are documented as being inherited from the OBJECT class. See
the list entitled "Methods Inherited from the Object Class" at the
beginning of the Stream class documentation.

----------------------------------------------------------------------

You can respond by visiting: 
https://sourceforge.net/tracker/?func=detail&atid=684730&aid=1623767&group_id=119701