DocsViewController

class DocsViewController : UIViewController

This is a class created for presenting all the benefits for using Jazzy

  • Undocumented

    Declaration

    Swift

    var titleLabel: UILabel

  • Undocumented

    Declaration

    Swift

    var subtitleLabel: UILabel

  • Undocumented

    Declaration

    Swift

    var closeButton: UIButton

  • Undocumented

    Declaration

    Swift

    var alertButton: UIButton

  • Undocumented

    Declaration

    Swift

    override func viewDidLoad()

Setup Methods

  • Call this method for setting up the title label.

    Usage:

    setupTitleLabel(with: "Documentation for Swift and Objective-c project using Jezzy")

    Declaration

    Swift

    func setupTitleLabel(with text: String)

    Parameters

    text

    Define the text for the label

  • Call this method for setting up the subtitle label.

    Usage:

    setupSubtitleLabel(with: "How amazing it would be if we could simply focus on writing code and at the same time have all our project's documentation beautifully created automatically. Even better if it could have the same feel and style of Apple's official documentation.\n\nThat's completely possible using Jezzy!")

    Declaration

    Swift

    func setupSubtitleLabel(with text: String)

    Parameters

    text

    Define the text for the label

  • Call this method for setting up the dismiss button.

    Usage:

    setupCloseButton(systemName: "xmark.circle.fill")

    Declaration

    Swift

    func setupCloseButton(systemName: String)

    Parameters

    systemName

    Define an image icon from SF Symbols

  • Call this method for setting up the alert button.

    Usage:

    setupAlertButton(with: "Present Alert")

    Declaration

    Swift

    func setupAlertButton(with title: String)

    Parameters

    title

    This define the button title

Actions

  • Dismiss the DocsViewController

    Declaration

    Swift

    @objc
func closeButtonAction()

  • Present simple alert

    Declaration

    Swift

    @objc
func alertButtonAction()

UI

  • Handle all the UI components sizes and positioning for DocsViewController

    Note

    This is how you can add notes to the documentation

    Warning

    This is an example of adding warning to the documentation.

    Declaration

    Swift

    func setupUI()