4.1 API Javadoc Doug Loynes, Open SiteSearch Product Support Specialist With version 4.1 of the Open SiteSearch Suite, users will find a new and revised version of the SiteSearch API (application program interface). The API was created with the Javadoc 1.2 application from Sun. Javadoc maps the class directories in the SiteSearch software to create the structure of the API. It then reads elements of the java files -- such as declarations and developer comments -- to provide technical content. This fully automated process ensures consistency between product documentation and the program files. The API for SiteSearch 4.1 is shipped with the SiteSearch software. You will find the API html files in your <WebZ_root>/htdocs/obiv1/help/api directory. The API is also available as a tarred file in the <WebZ_root>/htdocs/obiv1 directory. If you choose to use version zero of the OBI, you can move and open the API tar file to <WebZ_root>/htdocs/obiv0. To view the API, point your browser to the host and port of the webserver you defined when you installed 4.1 and add /help/api to the URL. For example: http://bongo:18818/help/api http://hostname:port/help/api Javadoc 1.2 includes a number of features and enhancements over version 1.1, which was used to create the SiteSearch 4.0 API. Display  The API now available in frames and non-frames versions  Information organized in a cleaner format  Tables and horizontal bars replace color-coded bullets and nonstandard fonts Navigation  More access points to API  Package -- lists all API packages  Class -- lists all classes and interfaces within a package  Use -- lists all methods and fields associated with a class or interface  Tree -- depicts hierarchical structure of each package  Toolbar provides quick navigation buttons for moving between and within packages Functionality  Deprecated classes and methods  Identifies all deprecated classes and methods in version 4.1.    Inherited methods  Shows the inherited methods at the end of the method summary table  Links to external APIs  The SiteSearch 4.1 API links to the java API for greater access to java classes.  Users can add hyperlinks to their own copies of the API.  Classes, packages and interfaces now included in the API index  Includes return types in method summaries and field types in field summaries  Lists subclasses for each class and implementing classes for each interface We hope this provides more tools for understanding the code and the interrelationships between classes. Please submit any bug reports or feature suggestions to the Product Support desk at . An email link is also available at the bottom of each of the API pages.

Links Back to Front Page SiteSearch 4.1 API Help Page Sun Javadoc 1.2