I think they should be documented as opaque classes/objects. Very little info should appear in the reference. More in depth information should appear in the programmer's guide.
Thanks,
W. David Ashley
IBM Systems and Technology Group Lab Services
Open Object Rexx Team
Mobile Phone: 512-289-7506
"Rick McGuire"
<[EMAIL PROTECTED]
l.com> To
Sent by: "Open Object Rexx Developer Mailing
oorexx-devel-boun List"
[EMAIL PROTECTED] <[email protected]
orge.net >
cc
08/24/2008 10:06 Subject
AM [Oorexx-devel] Documenting Pointer
and Buffer classes.
Please respond to
Open Object Rexx
Developer Mailing
List
<[EMAIL PROTECTED]
ts.sourceforge.ne
t>
I'm trying to figure out how the Pointer and Buffer classes should be
documented. These are Rexx classes, but they really only exist for
the benefit of authors of native libraries. For the most part,
"normal" users of ooRexx will never see an instance of these classes
and won't even know they exist. For that reason, I'm reluctant to
include these in the utility classes section because it will be very
difficult to document these outside of the context of the APIs and how
the APIs work. At the same time, you sort of need to understand these
are real ooRexx classes when using the API documentation, so it makes
sense that these classes should be part of the programmer's guide, not
in the reference. I'm interested in how others feel about these two
classes.
Rick
-------------------------------------------------------------------------
This SF.Net email is sponsored by the Moblin Your Move Developer's
challenge
Build the coolest Linux based applications with Moblin SDK & win great
prizes
Grand prize is a trip for two to an Open Source event anywhere in the world
http://moblin-contest.org/redirect.php?banner_id=100&url=/
_______________________________________________
Oorexx-devel mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/oorexx-devel
<<inline: graycol.gif>>
<<inline: pic07253.gif>>
<<inline: ecblank.gif>>
------------------------------------------------------------------------- This SF.Net email is sponsored by the Moblin Your Move Developer's challenge Build the coolest Linux based applications with Moblin SDK & win great prizes Grand prize is a trip for two to an Open Source event anywhere in the world http://moblin-contest.org/redirect.php?banner_id=100&url=/
_______________________________________________ Oorexx-devel mailing list [email protected] https://lists.sourceforge.net/lists/listinfo/oorexx-devel
