How This API Document Is Organized

Treatment of BBj Types

Any BBj types which are documented are linked to the intern documentation of BASIS

Markdown Support

The whole descriptions of the classes/interfaces and their fields, constructors and methods have a markdown to html support.
The Copyright of the used markdown converter belongs to: Atlassian Pty Ltd
License: The license of the owner.

Supported Parameters of BBjDoc in creation:

• author: This option shows the @author tag in the documention.
• bottom 'text': If this string is set, a new line is created on each bottom line of the documentation with the content of the given 'text'.
• [deprecated]docPrivate: This option commands the documentation to document everything marked as public, protected and private.
• [deprecated]docProdected: This option commands the documentation to document everything marked as public and protected.
• doctitle 'title': If this string is set, the heading of the overview-summary file of the documentation will set to the given 'title'.
• docVisibility: With this option an enum can be set (BBjDocsParameters.Visibility).
•   Setting PROTECTED and the BBjDocsGenerator will document public and protected structures.
•   Setting PRIVATE and the BBjDocsGenerator will document public, protected and private structures.
•   Without setting anything the BBjDocsGenerator will only document public structures.
• logPath: The logs which are generated during creation of the documentation are saved at this path.
• -------->Default logpath is the default tmp directory in the OS<--------
• newlines: This parameter converts "\n" to "< br >" tags unless they are following any html tags.
• noDeprecatedList: The resulting documentation won't contain a deprecated list.
• noIndex: The resulting documentation won't contain a index file.
• noSince: This option hides the @since tag in the documention.
• noTree: The resulting documentation won't contain a tree overview.
• noTimestamp: This option hides the timestamp which is written in a hidden html comment on the beginning of each site of the documention.
• stylesheet 'path': The documentation will use the stylesheet at this path.
• top 'text': If this string is set, a new line is created on each top line of the documentation with the content of the given 'text'.
• verbose: The messages of the logger are shown.
• version: This option shows the @version tag in the documention.

Custom Placeholders and Templates

Custom Templates and placeholders can be added to the documentation using the parameter class, which contains the parameter options above.
Setting a new template:
BBjDocsParameters.setClassTemplate(String filepathToTheTemplate)
BBjDocsParameters.setTreeTemplate(String filepathToTheTemplate)
...

Setting a new placeholder for class and use files:
BBjDocsParameters.setClassPlaceHolder(String filePath, HashMap replacementMap)
BBjDocsParameters.setUsePlaceHolder(String filePath, HashMap replacementMap)


Explanation:
The filepath parameter has to be the original filepath of the BBj Source file the documentation page OR the use page is based on.
The replacement map contains the placeholders as keys and the replacements as values.


Setting a new placeholder for other pages of the documentation:
BBjDocsParameters.setTreePlaceHolder(String placeHolder, String replacement)

Packages

It is possible to define packages in bbj, which are documented by this tool:

rem /**
rem * Javadoc comments
rem */
rem package main


rem /**
rem * Javadoc comments
rem */
rem package main.first


rem /**
rem * Javadoc comments
rem */
rem package main.second

Defining these packages at the tops of different BBj Source Files will result in the following folder structure, creating the main folder
in the savepath folder with the other additional files like overviews:

main
+-- first
+-- second

If packages have been defined, each package has a page that contains a list of its classes and interfaces, with a summary for each.

Navigation Bar

This API document has pages corresponding to the items in the navigation bar, described as follows.

Overview

The Overview page is the front page of this API document and provides a list of all packages with a summary for each. This page can also contain an overall description of the set of packages.

Use

Each documented class and interface has its own Use page. This page describes what classes, methods, constructors and fields use any part of the given class or package. Given a class or interface A, its Use page includes fields declared as A, methods that return A, and methods and constructors with parameters of type A. You can access this page by first going to the package, class or interface, then clicking on the "Use" link in the navigation bar.

Tree (Class Hierarchy)

There is a Class Hierarchy page for the whole project. The hierarchy page contains a list of classes and a list of interfaces. The classes are organized by inheritance structure starting with the highest upperclass the tool can find..

Deprecated API

The Deprecated API page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.

Index

The Index contains an alphabetic list of all classes, interfaces, constructors, methods, and fields.

Prev/Next

These links take you to the next or previous class, interface, package, or related page.

Frames/No Frames

These links show and hide the HTML frames. All pages are available with or without frames.

All Classes

The All Classes link shows all classes and interfaces.