Jump to content

Talk:Introduction to the OS/2 API Documentation: Difference between revisions

From EDM2
Add prototypes?
 
(3 intermediate revisions by the same user not shown)
Line 29: Line 29:


---[[User:Prokushev|Prokushev]]
---[[User:Prokushev|Prokushev]]
===Function Empty Wiki Format===
[[User:Martini|Martini]] ([[User talk:Martini|talk]]) 16:20, 17 August 2017 (CEST)
<PRE>
{function name as Page Name}
== Syntax ==
== Parameters ==
== Constants ==
None. {list of used constants}
== Returns ==
NO_ERROR  {list of return codes}
ERROR_INVALID_FREQUENCY
== Module ==
DOSCALLS {name of export module}
== Define (C/C++) ==
== Ordinal/Export name ==
== Calling convention ==
[[Cdecl32]] {Calling convertion of function. Possible values are: Cdecl32, Cdecl16, Pascal32 & Pascal16}
== Remarks ==
== Example Code ==
<PRE>
== Related Functions ==
* [[]]
== OS Version Introduced ==
OS/2 2.1
[[Category:]]
</PRE>
==Data Type Wiki Format==
<PRE>
<Data type description>
== Type ==
 
== C Declaration Method ==
== Fields ==
== Remarks ==
== Example Code ==
<PRE>
[[Category:Data type]]
</PRE>

Latest revision as of 16:33, 17 August 2017

Prototypes?

Personally, I like to have C function prototypes in the documentation. Not having used much of this project for my own ends (it's too sparse still), I can't say, but I believe it'll make it easier to see at a glance how to use the function. Instead of wading through the parameter list.

That is, adding something like this to the API entries:

Prototype

APIRET DosBeep( ULONG frequency, ULONG duration );

What do you ppl think? --Myrkraverk 00:17, 6 November 2007 (CET)

SOM Namespace

Is SOM namespace exists? ---Prokushev


Do you mean like <edm2 url>/SOM:<content link here>?

If so, I haven't done anything with SOM, but I think it is a great idea. Go for it!

I think there should also be something like <edm2 url>/DSOM:<content link here>. ---Daniel

Now THE QUESTION. How to create it? ;) According DSOM. Not sure we need separate DSOM from SOM. But can be usefull for CORBA compatability analyze.

---Prokushev

Function Empty Wiki Format

Martini (talk) 16:20, 17 August 2017 (CEST)

{function name as Page Name}

== Syntax == 
 
== Parameters ==


== Constants ==
None. {list of used constants}

== Returns ==
 NO_ERROR  {list of return codes}
 ERROR_INVALID_FREQUENCY

== Module ==
DOSCALLS {name of export module}

== Define (C/C++) ==

== Ordinal/Export name ==


== Calling convention ==
[[Cdecl32]] {Calling convertion of function. Possible values are: Cdecl32, Cdecl16, Pascal32 & Pascal16}

== Remarks ==

== Example Code ==
<PRE>

== Related Functions ==
* [[]]

== OS Version Introduced ==
OS/2 2.1

[[Category:]]

Data Type Wiki Format

<Data type description>

== Type ==
   
== C Declaration Method ==

== Fields ==

== Remarks ==

== Example Code ==
<PRE>



[[Category:Data type]]