| Property | Type | Description | |
|---|---|---|---|
| $_depth | integer | The directory structure depth. Used to calculate relative paths. | |
| $_doclet | doclet | The doclet that created this object. | |
| $_gitHubBranch | string | ||
| $_gitHubRepository | string | ||
| $_gitHubSourceDirectory | string | ||
| $_gitHubSourcesBranch | string | ||
| $_gitHubSourcesRepository | string | ||
| $_id | str | The id attribute value, used for selecting style. | |
| $_output | str | The output body. |
| Method | Description | |
|---|---|---|
| _asPath ( $element ) | ||
| _asURL ( $element ) | ||
| _fieldSignature ( $element ) | ||
| _flatSignature ( $method ) | ||
| _methodSignature ( $method ) | ||
| _normalize ( $name ) | ||
| _processInlineTags ( &$tag, $first = FALSE ) : str | Convert inline tags into a string for outputting. | |
| _processTags ( &$tags ) : str | Format tags for output. | |
| _sourceLocation ( $doc ) | ||
| _write ( $path ) | Write the HTML page to disk using the given path. | |
| getDirBaseURL ( ) | ||
| getFileBaseURL ( ) | ||
| getSourcesBaseURL ( ) | ||
| mdWriter ( &$doclet ) | Writer constructor. |
| public _processInlineTags ( &$tag, $first = FALSE ) : str | ||
| return | str | The string representation of the elements doc tags |
| public _processTags ( &$tags ) : str | ||
| return | str | The string representation of the elements doc tags |
| public int $_depth | ||
| return | integer | |
| public doclet $_doclet | ||
| return | doclet | |
| public str $_id | ||
| return | str | |