Free Trial

Safari Books Online is a digital library providing on-demand subscription access to thousands of learning resources.

  • Create BookmarkCreate Bookmark
  • Create Note or TagCreate Note or Tag
  • PrintPrint
Share this Page URL
Help

6. Custom Connectivity > Documenting Your Connector

Documenting Your Connector

In order to compile and generate the connector, the DevKit requires a minimum set of JavaDoc comments and tags for code that utilize certain DevKit annotations. These tags will then produce a simple and elegant tab-based website complete with an installation guide, JavaDocs, and example code.

Connectors

Each class annotated with @Connector must have a class-level JavaDoc comment with a high-level overview of the connector and must include an @author tag detailing the author of the connector:

/**
 * Cloud Connector
 *
 * @author MuleSoft, Inc.
 */
@Connector(name="googlemaps", schemaVersion="1.0-SNAPSHOT")
public class GoogleMapsConnector

Configurable Fields

Each field annotated with @Configurable is required to have a JavaDoc comment briefly explaining what this attribute is used for:


  

You are currently reading a PREVIEW of this book.

                                                                                                                    

Get instant access to over $1 million worth of books and videos.

  

Start a Free Trial


  
  • Safari Books Online
  • Create BookmarkCreate Bookmark
  • Create Note or TagCreate Note or Tag
  • PrintPrint