Refreshing the HTML documentation  Importing existing IDL modules

Chapter 5: Defining Component Interfaces

Viewing HTML documentation for IDL modules

EAServer creates HTML documentation for all imported IDL modules in the style of Sun’s javadoc tool. At a minimum, this documentation lists the datatypes and interfaces defined in the module, including structure fields, array lengths, parameter names and datatypes, exceptions thrown by methods, and so forth. When editing IDL, you can also create specially-formatted comments that provide descriptions of entities declared in the IDL file, as described in “Adding IDL documentation comments”.

Module documentation can be viewed in a Web browser by connecting to your server with this URL:

http://yourhost:yourport/ir/

where yourhost is the host name and yourport is the HTTP port number.





Copyright © 2005. Sybase Inc. All rights reserved. Importing existing IDL modules

View this book as PDF