Introduction to the OS/2 API Documentation: Difference between revisions
mNo edit summary |
No edit summary |
||
| Line 12: | Line 12: | ||
After EDM/2 was relaunched in 2004 [[Daniel.Lee.Kruse]] started [[OS2 API|OS/2 API Documentation]] pages. Wiki provided good chance to make this project live. | After EDM/2 was relaunched in 2004 [[Daniel.Lee.Kruse]] started [[OS2 API|OS/2 API Documentation]] pages. Wiki provided good chance to make this project live. | ||
This article describes how eny API entry must be described. | |||
== API entry definition == | == API entry definition == | ||
Each API entry must be described and documented in common and standard representation form. | Each API entry must be described and documented in common and standard representation form. | ||
== Messages definition == | == Messages definition == | ||
| Line 27: | Line 31: | ||
[[SOM]] interfaces has different description format. Mainly, [[Interface Definition Language]] describes [[SOM]] interface fully, but not in easy to understand form (without IDL background knowlidges). | [[SOM]] interfaces has different description format. Mainly, [[Interface Definition Language]] describes [[SOM]] interface fully, but not in easy to understand form (without IDL background knowlidges). | ||
Also another specifig things, like no export entries for methods, no exact known location, etc. | Also another specifig things, like no export entries for methods, no exact known location, etc. | ||
== Types definition == | |||
== Constants definition == | |||
Revision as of 08:40, 12 November 2005
by Prokushev, Daniel.Lee.Kruse
Introduction
OS/2 and eComStation API not available for public domain. If for OS/2 users is only possible way to get API documentation via buying OS/2 Toolkit then eComStation users in better situation - OS/2 Toolkit shipped in the box. Anyway, OS/2 Toolkit documentation contain errors, not all API documented etc. Lot of parts just missed. eComStation comes with newer interfaces, but they not described in any eComStation official documentation.
In 1996 The OS/2 API project was started. But copyright issues not allowed to extend project after maintainers lost interest in it. So, all work from the OS/2 API project was lost.
After EDM/2 was relaunched in 2004 Daniel.Lee.Kruse started OS/2 API Documentation pages. Wiki provided good chance to make this project live.
This article describes how eny API entry must be described.
API entry definition
Each API entry must be described and documented in common and standard representation form.
Messages definition
Messages also can be interpreted as API entry. Usually you calls API function WinSendMsg and recieves result. Each message has some specific parameters and return codes. So, message also must be represented in some form.
SOM Interface definition
SOM interfaces has different description format. Mainly, Interface Definition Language describes SOM interface fully, but not in easy to understand form (without IDL background knowlidges). Also another specifig things, like no export entries for methods, no exact known location, etc.