Skip to main content
Version: Latest

JavaDocs API Reference

Online JavaDocs​

The complete JavaDocs for Brobot are available online:

Maven Central Integration​

Version 1.1.0 is now available on Maven Central! 🎉

When you include Brobot in your project via Maven or Gradle, your IDE will automatically download and display the JavaDocs:

Maven​

<dependency>
    <groupId>io.github.jspinak</groupId>
    <artifactId>brobot</artifactId>
    <version>1.1.0</version>
</dependency>

Gradle​

implementation 'io.github.jspinak:brobot:1.1.0'

Previous Versions​

Previous versions remain available:

implementation 'io.github.jspinak:brobot:1.0.7' // Previous stable release

Generating JavaDocs Locally​

To generate JavaDocs locally from the source code:

# Clone the repository
git clone https://github.com/jspinak/brobot.git
cd brobot

# Generate JavaDocs
./gradlew :library:javadoc

# The JavaDocs will be generated in:
# library/build/docs/javadoc/

To generate JavaDocs with versioning (for GitHub Pages deployment):

# Generate versioned JavaDocs
./gradlew :library:javadocForGitHubPages

# Create latest symlink
./gradlew :library:createLatestSymlink

# The JavaDocs will be in:
# library/build/docs/javadoc/1.1.0/
# library/build/docs/javadoc/latest/

Key API Packages​

Core Packages​

Action Options​

  • io.github.jspinak.brobot.actions.options - Action configuration classes
    • PatternFindOptions - Configure pattern matching
    • ClickOptions - Configure click actions
    • TypeOptions - Configure typing actions
    • DragOptions - Configure drag operations

State Management​

Image Processing​

Important Classes​

Action Classes​

  • Action - Main class for performing actions
  • ActionBuilder - Fluent API for building complex actions
  • ConditionalActionChain - Chain conditional actions

Data Types​

  • State - Represents an application state
  • StateImage - Pattern or image to find
  • Region - Screen region definition
  • Location - Screen location/point
  • Matches - Pattern match results

Configuration​

  • FrameworkSettings - Global framework settings
  • BrobotSettings - Application-specific settings

IDE Integration​

Most modern IDEs will automatically:

  1. Download JavaDocs when you add Brobot as a dependency
  2. Show documentation on hover
  3. Provide auto-completion with documentation
  4. Allow navigation to source code (if sources are attached)

IntelliJ IDEA​

JavaDocs are automatically downloaded and displayed. Press Ctrl+Q (Windows/Linux) or F1 (Mac) to view quick documentation.

Eclipse​

JavaDocs are downloaded with the dependency. Hover over any Brobot class or method to see documentation.

VS Code​

With Java extensions installed, JavaDocs will be displayed on hover and in auto-completion.

Contributing to Documentation​

To improve the JavaDocs:

  1. Add JavaDoc comments to your code:
/**
 * Performs a click action on the specified StateImage.
 *
 * @param stateImage The image pattern to click on
 * @return ActionResult containing the result of the action
 * @throws ActionException if the action fails
 */
public ActionResult click(StateImage stateImage) {
    // Implementation
}

  1. Follow JavaDoc conventions:

    • Use @param for parameters
    • Use @return for return values
    • Use @throws for exceptions
    • Use @see for related classes/methods
    • Use @since for version information

  2. Generate and review locally before submitting PR:

./gradlew :library:javadoc
# Open library/build/docs/javadoc/index.html in browser

Version History​

  • 1.1.0 - Latest release (September 2025)
    • Enhanced API documentation with comprehensive Javadoc coverage
    • Cross-platform build compatibility (Windows, Linux, macOS)
    • Improved CI/CD pipeline with full test coverage
    • Fixed Javadoc generation issues across all platforms
  • 1.0.7 - Previous stable release
  • Earlier versions available on Maven Central

For detailed release notes, see the GitHub Releases page.