aer doc

Show documentation for Apex standard library and user code

Synopsis

Show documentation for namespaces, classes, interfaces, enums, or methods in the Apex standard library and user-defined code.

Examples:

aer doc                           # List all namespaces
aer doc System                    # List all classes/interfaces/enums in System namespace
aer doc System.Assert             # Show class details and methods
aer doc System.Assert.isTrue      # Show method signature
aer doc String                    # Show top-level class (no namespace)
aer doc String.split              # Show method on top-level class
aer doc Ns.Outer.Inner            # Show nested class
aer doc Ns.Outer.Inner.method     # Show method on nested class
aer doc --all                     # List all methods (Namespace.Class.Method format)
aer doc --path ./src              # Include user classes from directory
aer doc MyClass --path ./src      # Show details for user-defined class
aer doc [namespace|namespace.class|namespace.class.method] [flags]

Options

      --all                        List all methods
  -d, --default-namespace string   treat loaded code as if it belongs to the specified namespace
  -h, --help                       help for doc
      --package strings            package files to load (can be specified multiple times)
      --package-dir strings        directories containing .pkg files to load (can be specified multiple times)
      --path strings               directories containing Apex classes to load (can be specified multiple times)

Options inherited from parent commands

  -q, --quiet           suppress progress output
  -v, --verbose count   increase verbosity (repeat for more detail)

SEE ALSO

  • aer - aer is the Apex Execution Runtime
© 2012–2026 October Swimmer.