Skip Navigation
Type MethodMethod

isAvailable(for:)

Returns whether a shared sidebar document is generated for a navigation index.

static func isAvailable(for navigationIndex: NavigationIndex?) -> Bool

Parameters

navigationIndex

The navigation index, if any.

Return Value

true if the shared document exists for this index.

Discussion

A shared document is only generated when the index contains at least one module.