Hey, Guys,
Here are a couple of thoughts I had on how to approach making APIs
formally available and documented:
* Let's not try to API out our entire projects all at once, but
rather document (and create if necessary) the APIs that we
currently need. As additional APIs are needed, let's document
them (and create them if necessary), but not before they are
needed, as this takes time and energy that may not be used.
* I suggest that we define a simple API for documenting our
APIs. Something like a text file in the root of our source
trees called "README.APIs" or similar. This file would also
get copied to the documentation directory when installed.
* I suggest that we define a simple format for adding entries to
the README.APIs files. Let me take a stab at it here:
API Name:
Usage:
Purpose:
Libraries needed:
Comments:
Thoughts?
-Brian
--
---------------------------------------------------
Brian Elliott Finley http://baldguysoftware.com/
phone: 214.280.8188 http://systemimager.org/
---------------------------------------------------
----------------------------------------------------------------------------
Bringing you mounds of caffeinated joy
>>> http://thinkgeek.com/sf <<<
_______________________________________________
Sisuite-devel mailing list
[EMAIL PROTECTED]
https://lists.sourceforge.net/lists/listinfo/sisuite-devel
