Update of /cvsroot/dynapi/dynapi/docs/config/data
In directory usw-pr-cvs1:/tmp/cvs-serv25888/data
Modified Files:
dynapi.js
Log Message:
Documentation updates.
Index: dynapi.js
===================================================================
RCS file: /cvsroot/dynapi/dynapi/docs/config/data/dynapi.js,v
retrieving revision 1.1
retrieving revision 1.2
diff -C2 -r1.1 -r1.2
*** dynapi.js 2001/01/20 21:36:13 1.1
--- dynapi.js 2001/01/21 06:08:55 1.2
***************
*** 1,4 ****
! /// A static top level object required for all DynAPI related functions
! /**
* The "DynAPI" object is the top level object in the DynAPI
* library. It is used primarily as a way to organize miscelleneous
--- 1,26 ----
! /** @mainpage %DynAPI API Reference
! *
! * @section intro Introduction
! * The %DynAPI API Reference provides the reference for the class used by the
%DynAPI.
! * For more information on the %DynAPI please visit
! * <a href="http://dynapi.sourceforge.net">dynapi.sourceforge.net</a>.
! *
! * @author Robert Rainwater, Pascal Bestebroer
! *
! * @section classes Classes
! * @li Browser
! * @li DragEvent
! * @li DynAPI
! * @li DynDocument
! * @li DynEvent
! * @li DynLayer
! * @li EventListener
! * @li MouseEvent
! */
!
!
!
! /** A static top level object required for all DynAPI related functions
! *
* The "DynAPI" object is the top level object in the DynAPI
* library. It is used primarily as a way to organize miscelleneous
***************
*** 10,15 ****
* that are in that document are in a collection underneath
* DynAPI.document.children[] and so on.
*/
-
static class DynAPI
{
--- 32,41 ----
* that are in that document are in a collection underneath
* DynAPI.document.children[] and so on.
+ *
+ * All DynAPI methods can be accessed like:
+ * @code
+ * DynAPI.addPackage("dynapi.api");
+ * @endcode
*/
static class DynAPI
{
***************
*** 31,36 ****
public:
! /// Adds a package to the DynAPI
! /**
* For example, DynAPI.addPackage("dynapi.api") makes
* the "dynapi.api" package available to be used with
--- 57,62 ----
public:
! /** Adds a package to the DynAPI
! *
* For example, DynAPI.addPackage("dynapi.api") makes
* the "dynapi.api" package available to be used with
***************
*** 38,44 ****
*/
void addPackage(string package);
! /// Adds the given array of file names to the given package name
! /**
! * For example, DynAPI.addPackage("dynapi.api",["dynlayer","dyndocument"]).
* If the given package does not exist, it will be created automatically.
*/
--- 64,74 ----
*/
void addPackage(string package);
! /** Adds the given array of file names to the given package name
! *
! * For example:
! * @code
! * DynAPI.addPackage("dynapi.api",["dynlayer","dyndocument"]);
! * @endcode
! *
* If the given package does not exist, it will be created automatically.
*/
***************
*** 46,56 ****
/// Returns "DynAPI" which is a reference to the DynAPI Object
string toString();
! /// Returns the DynDocument with the given id
! /**
* If no id is given, the default DynDocument is returned.
*/
DynDocument getDocument(string id);
! /// Removes index object from array
! /**
* If id is true then it removed index.id.
*/
--- 76,86 ----
/// Returns "DynAPI" which is a reference to the DynAPI Object
string toString();
! /** Returns the DynDocument with the given id
! *
* If no id is given, the default DynDocument is returned.
*/
DynDocument getDocument(string id);
! /** Removes index object from array
! *
* If id is true then it removed index.id.
*/
***************
*** 60,67 ****
/// Mounts the plugin object to be used during unload, load, and resize events
void mountplugin(object plugin);
! /// Includes the given library.
! /**
* If path is present, src is considered to be a acutall directory path.
* Otherwise, the given package file is included.
*/
void include(string src,string path);
--- 90,103 ----
/// Mounts the plugin object to be used during unload, load, and resize events
void mountplugin(object plugin);
! /** Includes the given library.
! *
* If path is present, src is considered to be a acutall directory path.
* Otherwise, the given package file is included.
+ *
+ * Two ways to use this method:
+ * @code
+ * DynAPI.include("dynapi.api.browser");
+ * DynAPI.include("myfile.js","../src/");
+ * @endcode
*/
void include(string src,string path);
_______________________________________________
Dynapi-CVS mailing list
[EMAIL PROTECTED]
http://lists.sourceforge.net/lists/listinfo/dynapi-cvs
