LEIF comes with a full set of documentation. For single-point access to the HTML documentation for LEIF, see installdir\docs\index.html.
In addition, the LEIF code generator creates documentation describing the generated code. Look in the docs subdirectory of the project directory.
Table 1 lists the names and locations of the LEIF documentation set.
| Document Format | Location |
readme files | installdir\docs\readmes |
Single-point access to HTML documentation: Overall LEIF documentation: Introduction to LEIF: installdir\docs\leif\html\leifintroug\index.html LEIF User's Guide: installdir\docs\leif\html\leifug\index.html LEIF Core Library Reference Guide: installdir\docs\leif\html\leifref\index.html Servlet Module documentation: XML Binding Development Guide: installdir\docs\leif\html\xmlbindingug\index.html XML Binding Library Reference Guide: installdir\docs\leif\html\xmlbindingref\index.html DB Access Module documentation: Servlet Development Guide: installdir\docs\leif\html\servletug\index.html Servlet Library Reference Guide: installdir\docs\leif\html\servletref\index.html Web services documentation: Web Services Development Guide: installdir\docs\leif\html\webservicesug\index.html Web Services Library Reference Guide: installdir\docs\leif\html\webservicesref\index.html | |
examples | installdir\examples |
The documentation for LEIF uses typographic conventions and pathname conventions similar to other Rogue Wave documentation. These conventions are summarized in the following tables:
| Conventions | Purpose | Example |
Courier | Function names, code, directories, file names, examples, operating system commands. | LEIF::CString:asString() out.println("<head>"); |
italic | variables in code Conventional uses, such as new terms and titles. | EXAMPLE_OBJS= myServlet.obj The deployment descriptor provides... |
bold italic | Class names, unnumbered subheadings, and emphasis. | |
bold | Conventional uses, such as emphasis. Commands from an interface. | You should always read the manual. Click the OK button |
... (or vertical ellipses) | Indicates part of the code is missing from an example. | foo(){ ... // Something happens } |
| Convention | Purpose | Example |
installdir | The directory where LEIF was installed. | c:\leif |
\ | The Windows delimiter in a path name. If you use UNIX, replace \ with /. | For installdir\html, a UNIX user enters installdir/html. |
Rogue Wave LEIF class names and types are typically referenced with the namespace qualification LEIF::. Template parameter values for templatized classes appear in angle brackets < > like this: LEIF::Enumeration<T>. Formal template parameters appear in text only when they are important to the discussion, so you may occasionally see this: LEIF::Enumeration<T>, but generally it is simply LEIF::Enumeration.
All member function names start with a lower case letter, but subsequent words are capitalized. All global function names start with the lowercase letters leif. In most class and function names, words are fully spelled out, for example:
A class name | |
getName() | A function name |
In our manuals, we sometimes refer to an instance of a class by an English name; for example, the "servlet class" instead of "LEIF::Servlet class." We do this for readability when the meaning should be clear from context. If there is possible ambiguity, however, we use the actual class name.
Throughout the documentation, references to "self" mean *this.
Our manuals present command lines in courier. When a command line is identical on all supported operating systems, the command begins with the word prompt, as shown below:
prompt> echo "The same on all systems."
When the syntax of a command line differs depending on the operating system, we provide a table that lists the operating systems and the command syntax. We use the word "Win32" for all versions of the Windows operating system. We use the phrase "UNIX/Linux" to mean UNIX operating systems and the Linux operating system. For UNIX and Linux systems, the syntax of a command may also depend on the shell. For example, the command below sets an environment variable:
Win32 | set PATH=%RWLEIF_HOME%\bin;%PATH% |
UNIX/Linux sh | PATH=$RWLEIF_HOME/bin:$PATH ; export PATH |
For Windows systems, use the command line in the first row. For a UNIX or Linux system, use the command in the second row.
©2003-2005 Copyright Quovadx, Inc. All Rights Reserved.
Rogue Wave is a registered trademark of Quovadx, Inc. in the United States and other countries. All other trademarks are the property of their respective owners.
Contact Rogue Wave about documentation or support issues.